コンテンツにスキップ

API Blueprint ドキュメントをインポートする

API Blueprint は、拡張された Markdown で API を記述する形式です。 Restorm は公式パーサー(Drafter)を WebAssembly にコンパイルして同梱しており、これで解析します。外部ツールは一切必要ありません。

ファイル ▸ インポートCtrl+I)から .apib ファイルを選択するか、FORMAT: 1A で始まる内容を貼り付けます。

要素Restorm での扱い
リソースグループフォルダー
各トランジションHTTP リクエスト
パラメーター型付きで取り込まれます
サーバーの URL環境のベース URL
説明とモデルAPI ドキュメント

トランジションごとに複数のサンプルがある場合

Section titled “トランジションごとに複数のサンプルがある場合”

API Blueprint のトランジションは、+ Request / + Response の組を複数宣言できます。 Restorm は組ごとに 1 つのリクエストを作成し、区別できるようにインデックスの接尾辞(#1#2 など)を付けます。