アダプタ定義ドキュメントへの機能の追加
1つの機能をアダプタに正常に追加およびテストした後、別のAPIリクエストのサポートを追加できます。
- Postman Collectionsの場合は、次のステップを実行します:
ノート:
アダプタ定義ドキュメントを新しいAPIリクエストで更新するには、最初に新しいリクエストをPostmanコレクションに追加し、コレクションをワークスペースにエクスポートする必要があります。 「APIリクエストを使用したPostmanコレクションの作成」を参照してください。- VS Codeで、サイドバーの「エクスプローラ」
をクリックします。ワークスペース・フォルダのディレクトリ構造が表示されます。 - 「その他」ディレクトリのリスト内で、更新されたコレクション・ファイルを右クリックし、「RAB: Postmanコレクションからのリクエストの追加」をクリックします。
- 「リクエストの選択」ペインで、追加する新しいリクエストを選択し、「完了」をクリックします。
- VS Codeで、サイドバーの「エクスプローラ」
- OpenAPIドキュメントの場合は、次のステップを実行します:
- 更新されたOpenAPIドキュメントを、ワークスペース・フォルダのapiディレクトリにインポートします。
- VS Codeで、サイドバーの「エクスプローラ」
をクリックします。ワークスペース・フォルダのディレクトリ構造が表示されます。 - apiディレクトリのリスト内で、インポートした更新済のOpenAPIドキュメントを右クリックし、「名前の変更」をクリックします。更新されたドキュメントの名前を
openapi.resource.jsonに変更します。ノート:
以前にインポートした同じOpenAPIドキュメントを使用して新しいリクエストを選択する場合は、ドキュメントの名前を変更する必要がない場合があります。 - ドキュメントを再度右クリックし、「RAB: OpenAPIドキュメントによるアクションの更新」をクリックします。
- 「リクエストの選択」ペインで、追加する新しいリクエストを選択し、「完了」をクリックします。新しいリクエストを追加したり、以前に変換したリクエストを削除したりするには、それらのチェックを解除します。 選択内容のサマリーがペインの上部に表示されます。
- 表示されるダイアログ・ボックスで、元のPostmanコレクション(またはOpenAPIドキュメント)をアダプタ定義ドキュメントに変換する際に選択した内容に基づいて、次のいずれかのオプションを選択します。 「アダプタ定義ドキュメントの生成」を参照してください。
- 前にメイン・ドキュメント(
main.add.json)を使用することを選択した場合は、「メインの更新」をクリックして、新しいリクエストを同じドキュメントに追加します。 - メイン・ドキュメントを使用していない場合は、「新規保存」をクリックします。
これで、VS Code拡張によって、選択したドキュメントに新しいリクエストが追加されます。ノート:
「新規保存」を選択すると、拡張によって新しいドキュメントが生成され、ワークスペースのdefinitionsディレクトリに保存されます。 その後、この新しいドキュメント(更新されたリクエストを含む)の名前を前のドキュメントの名前に変更して置き換えることができます。 - 前にメイン・ドキュメント(
- キーボードのCtrl+Sを押してドキュメントを保存します。
次のステップ: アダプタ定義ドキュメントの確認および更新