VS Code拡張を使用すると、エクスポートされたPostmanコレクションまたはOpenAPIドキュメントからアダプタ定義ドキュメントを生成できます。
- Postman Collectionsの場合は、次のステップを実行します:
- VS Codeで、サイドバーの「エクスプローラ」
をクリックしてエクスプローラ・ビューを表示します。ワークスペース・フォルダのディレクトリ構造が表示されます。
- 「その他」ディレクトリ・リストをクリックして展開します。
- エクスポートされたコレクション・ファイル(
<ApplicationName>_Adapter.postman_collection.json)を右クリックし、「RAB: Postmanコレクションを変換」をクリックします。
- 「リクエストの選択」ペインで、変換するリクエストを選択し、「完了」をクリックします。
- OpenAPIドキュメントの場合は、次のステップを実行します:
- OpenAPIドキュメント(JSON形式)をワークスペース・フォルダのapiディレクトリにインポートします。
- VS Codeで、サイドバーの「エクスプローラ」 をクリックしてエクスプローラ・ビューを表示します。
ワークスペース・フォルダのディレクトリ構造が表示されます。
- apiディレクトリ・リストをクリックして展開します。
- インポートしたOpenAPIドキュメントを右クリックし、「名前の変更」をクリックします。
ドキュメントの名前をopenapi.resource.jsonに変更します。
- ドキュメントを再度右クリックし、「RAB: OpenAPIドキュメントの変換」をクリックします。
- 「リクエストの選択」ペインで、変換するリクエストを選択し、「完了」をクリックします。
ノート:
200を超えるリクエストがあるOpenAPIドキュメントは変換できません。
- 表示されるダイアログ・ボックスで、次のいずれかのオプションを選択できます:
- 「メインの更新」をクリックして、VS Code拡張(
main.add.json)が付いたデフォルト・ドキュメントにリクエストを追加します。
- 「新規保存」をクリックして、新しいアダプタ定義ドキュメントを生成します。
VS Code拡張は、リクエストを選択したドキュメントに変換します。 新しいドキュメントの作成を選択すると、拡張によってドキュメントが生成され、ワークスペースのdefinitionsディレクトリに保存されます。 さらに、ドキュメントがVS Codeエディタで開きます。
ノート:
新しいドキュメントを作成する場合、VS Code拡張は、それをアダプタ定義ドキュメントとして認識しません。 拡張機能では、デフォルトのドキュメントmain.add.jsonのみが認識されます。 新しいドキュメントからデフォルトのドキュメントにコンテンツをコピーするか、新しいドキュメントの名前をmain.add.jsonに変更できます。
- アダプタ定義ドキュメントにAPIレスポンス・スキーマが含まれていることを確認してください。
- キーボードのCtrl+Sを押してファイルを保存します。