API をインポートする
Restorm は 24 種類の形式を認識し、そこから完全なプロジェクトツリーを再構築します。フォルダー、リクエスト、環境、API ドキュメント、列挙型がまとめて生成されます。
ほとんどの場合、これが最良の出発点です。仕様書が存在するなら、リクエストを手で書く必要はありません。
インポートの方法
Section titled “インポートの方法”ファイル ▸ インポート（Ctrl+I）は次のいずれも受け付けます。
- ディスク上のファイル。
- URL — オンラインで配信されている
swagger.jsonや$metadataに便利です。 - 貼り付けた内容 —
curlコマンドをリクエストに変換するのはこの方法です。
Restorm は形式を自動で判別します。まずファイル拡張子から、次に内容を解析して判定するため、こちら側で選ぶ必要はありません。
API 仕様
Section titled “API 仕様”| 形式 | ページ |
|---|---|
| OpenAPI 3.x と Swagger 2.0 | OpenAPI / Swagger |
| GraphQL スキーマ（SDL） | GraphQL |
.proto ファイルと gRPC reflection | gRPC |
| WSDL | SOAP / WSDL |
| AsyncAPI | AsyncAPI |
| OData EDMX / CSDL | OData |
| OpenRPC | OpenRPC |
| tRPC スキーマ | tRPC |
| Smithy | Smithy |
| TypeSpec | TypeSpec |
| RAML | RAML |
| WADL | WADL |
| Thrift | Thrift |
| API Blueprint | API Blueprint |
他のクライアントのコレクション
Section titled “他のクライアントのコレクション”| 形式 | ページ |
|---|---|
| Postman | Postman |
| Insomnia | Insomnia |
| Bruno | Bruno |
| Thunder Client | Thunder Client |
| Paw / RapidAPI | Paw |
| HTTPie | HTTPie |
VS Code REST Client（.http） | REST Client |
キャプチャとコマンドライン
Section titled “キャプチャとコマンドライン”| 形式 | ページ |
|---|---|
| HAR（ブラウザーのキャプチャ） | HAR |
curl コマンド | cURL |
Invoke-RestMethod / Invoke-WebRequest | PowerShell |
得られるもの
Section titled “得られるもの”元の形式がどれだけ豊富な情報を持つかによって、次のものが生成されます。
- 1 つまたは複数の環境を含む変数フォルダー。ベース URL は仕様書から抽出されます。
- フォルダーのツリー構造 — 形式に応じて、タグ単位・サービス単位・リソース単位に分かれます。
- 操作ごとに 1 つのリクエスト。プロトコルに対応した種類で作成されます。
- フォルダーに紐づく API ドキュメント — モデル、説明、セキュリティスキーム、レスポンス例。
- 仕様書に定義された列挙型。値の型として再利用できます。
- 変数とともに事前設定された認証ヘッダー — 認証を参照してください。
インポート後、値が空に解決されるキー / 値のペアは自動的に無効化されます。そのため、最初の送信で空のヘッダーが大量に送られてしまうことはありません。
インポートした API のドキュメント
Section titled “インポートした API のドキュメント”インポートはリクエストだけを生成するわけではありません。API のドキュメント（説明、モデル、セキュリティ、例、列挙型）も保持し、作成されたフォルダーの ドキュメント タブから参照できます。インポートした API のドキュメントの参照と更新を参照してください。
インポートを更新する
Section titled “インポートを更新する”12 種類の形式は再同期に対応しています。Restorm はソースの新しいバージョンと既存のツリーを比較し、差分だけを適用するため、加えた変更は失われません。ソースから更新するを参照してください。
エクスポートは？
Section titled “エクスポートは？”Restorm は各リクエストについて、そのプロトコルに関係するすべての言語向けにコードスニペットを生成します。コードのエクスポートを参照してください。