跳到內容

匯入 Smithy 模型

Smithy 是 AWS 的 API 建模語言。Restorm 可匯入它的兩種表示形式。

檔案 ▸ 匯入Ctrl+I),然後選擇:

  • 一個 .smithy 檔案(建模語言本身);
  • 或由 smithy build 產生的 JSON AST

兩者最終都會匯聚到相同的內部模型。

項目Restorm 的處理方式
每個 service / resource一個資料夾
每個帶有 @http 的操作一個 HTTP 請求
@httpLabel一個路徑參數
@httpQuery一個查詢參數
@httpHeader一個標頭
說明文件與型別API 文件與列舉
  • 沒有 @http trait 的操作只具文件性質:它會出現在 API 文件中,但不會 產生請求。
  • SigV4 身分驗證不會預先接線:請自行手動設定。
  • 非 REST 的協定綁定awsJson1_1awsQuery…)並未建模。
  • 清單、字典與聯集不是第一級的結構形式。
  • 驗證類 trait(@pattern@length@paginated@readonly…)會被靜默 忽略。
  • Smithy 的協定測試會被忽略。

Smithy 屬於可重新同步的格式。請參閱 從來源更新