Smithy モデルをインポートする
Smithy は AWS の API モデリング言語です。Restorm はその 2 つの表現形式をインポートできます。
ファイル ▸ インポート(Ctrl+I)から、次のいずれかを指定します。
.smithyファイル(モデリング言語そのもの)- または
smithy buildが生成する JSON AST
どちらも同じ内部モデルに行き着きます。
インポートされる内容
Section titled “インポートされる内容”| 要素 | Restorm での扱い |
|---|---|
各 service / resource | フォルダー |
@http を持つ各操作 | HTTP リクエスト |
@httpLabel | パスパラメーター |
@httpQuery | クエリパラメーター |
@httpHeader | ヘッダー |
| ドキュメントと型 | API ドキュメントと列挙 |
制限事項(インポートのバージョン 1)
Section titled “制限事項(インポートのバージョン 1)”@httpトレイトを持たない操作はドキュメント用のみです。API ドキュメントには表示されますが、リクエストは生成されません。- SigV4 認証は事前設定されません。 手動で設定してください。
- REST 以外のプロトコルバインディング(
awsJson1_1、awsQueryなど)はモデル化されません。 - リスト、マップ、ユニオンは第一級の形状として扱われません。
- 検証系のトレイト(
@pattern、@length、@paginated、@readonlyなど)は警告なく無視されます。 - Smithy のプロトコルテストは無視されます。
Smithy は再同期に対応した形式のひとつです。ソースから更新するを参照してください。