跳转到内容

导入 Smithy 模型

Smithy 是 AWS 的 API 建模语言。Restorm 支持导入它的两种表示形式。

文件 ▸ 导入Ctrl+I),然后选择:

  • 一个 .smithy 文件(建模语言本身);
  • 或者 smithy build 生成的 JSON AST

两者最终都会汇聚到同一个内部模型。

元素Restorm 如何处理
每个 service / resource一个文件夹
每个带 @http 的操作一个 HTTP 请求
@httpLabel一个路径参数
@httpQuery一个查询参数
@httpHeader一个请求头
文档与类型API 文档与枚举
  • 不带 @http 特征的操作仅作为文档存在:它会出现在 API 文档中,但不会生成 请求。
  • SigV4 身份验证不会被预先接好:请手工配置。
  • 非 REST 的协议绑定awsJson1_1awsQuery……)未被建模。
  • 列表、字典和联合类型不是一等结构。
  • 校验类特征(@pattern@length@paginated@readonly……)会被静默忽略。
  • Smithy 的协议测试会被忽略。

Smithy 属于可重新同步的格式。参见 从源更新