コンテンツにスキップ

Smithy モデルをインポートする

Smithy は AWS の API モデリング言語です。Restorm はその 2 つの表現形式をインポートできます。

ファイル ▸ インポートCtrl+I)から、次のいずれかを指定します。

  • .smithy ファイル(モデリング言語そのもの)
  • または smithy build が生成する JSON AST

どちらも同じ内部モデルに行き着きます。

要素Restorm での扱い
service / resourceフォルダー
@http を持つ各操作HTTP リクエスト
@httpLabelパスパラメーター
@httpQueryクエリパラメーター
@httpHeaderヘッダー
ドキュメントと型API ドキュメントと列挙

制限事項(インポートのバージョン 1)

Section titled “制限事項(インポートのバージョン 1)”
  • @http トレイトを持たない操作はドキュメント用のみです。API ドキュメントには表示されますが、リクエストは生成されません。
  • SigV4 認証は事前設定されません。 手動で設定してください。
  • REST 以外のプロトコルバインディングawsJson1_1awsQuery など)はモデル化されません。
  • リスト、マップ、ユニオンは第一級の形状として扱われません。
  • 検証系のトレイト(@pattern@length@paginated@readonly など)は警告なく無視されます。
  • Smithy のプロトコルテストは無視されます。

Smithy は再同期に対応した形式のひとつです。ソースから更新するを参照してください。