API Blueprint ドキュメントをインポートする
API Blueprint は、拡張された Markdown で API を記述する形式です。 Restorm は公式パーサー(Drafter)を WebAssembly にコンパイルして同梱しており、これで解析します。外部ツールは一切必要ありません。
ファイル ▸ インポート(Ctrl+I)から .apib ファイルを選択するか、FORMAT: 1A で始まる内容を貼り付けます。
インポートされる内容
Section titled “インポートされる内容”| 要素 | Restorm での扱い |
|---|---|
| リソースグループ | フォルダー |
| 各トランジション | HTTP リクエスト |
| パラメーター | 型付きで取り込まれます |
| サーバーの URL | 環境のベース URL |
| 説明とモデル | API ドキュメント |
トランジションごとに複数のサンプルがある場合
Section titled “トランジションごとに複数のサンプルがある場合”API Blueprint のトランジションは、+ Request / + Response の組を複数宣言できます。
Restorm は組ごとに 1 つのリクエストを作成し、区別できるようにインデックスの接尾辞(#1、#2 など)を付けます。