Postmanアプリケーションでコレクションを作成し、必要なAPIリクエストを追加およびテストし、コレクションをJSONファイルにエクスポートします。
アダプタの構築中に、Postmanコレクションから開始すると、複数のAPIリクエストをコレクションにグループ化し、要件に応じてレスポンスを形成できるため、時間を節約できます。
PostmanコレクションでAPIリクエストをテストする場合は、受信したレスポンスを保存して、Rapid Adapter Builderがアダプタ定義ドキュメントにスキーマを生成できるようにする必要があります。
ヒント:
小さく始めます。 少なくとも最初のアダプタの場合は、1つのAPIリクエストのみでPostmanコレクションを作成します。 アダプタを構築およびテストした後、必要に応じて別のAPIのサポートを追加できます。 「アダプタを作成するためのベスト・プラクティス」を参照してください。 後続の反復では、existing Postmanコレクションを使用して、新しいリクエストを追加できます。 「コレクションへの新規リクエストの追加」を参照してください。
- Postmanアプリケーションを開き、アカウントでサインインします。
- コレクションの作成
- 左ペインで「コレクション」が選択されている状態で、「新規」をクリックし、表示されるダイアログで「コレクション」をクリックします。
新しい空白のコレクションが作成され、左ペインにリストされます。
- 右側の「概要」タブで、デフォルトのコレクション名(「新規コレクション」)をクリックしてコレクションの名前を変更します。 たとえば、「
<ApplicationName>_Adapter」と入力します。
- 前に詳細を取得したAPIリクエストを追加し、テストして、レスポンスを例として保存します。
- 左ペインで、新しく作成されたコレクションの下にある「リクエストの追加」をクリックします。
新しい空白のリクエストが作成され、表示されます。 ワークスペースの上部にある「新規リクエスト」フィールドをクリックして、リクエストの名前を変更します。
- リクエストのURLフィールドで、右側のHTTP動詞を選択し、前に取得したリクエストURLを入力します。 「APIコールの詳細の取得」を参照してください。
- パラメータ、認可詳細、ヘッダーなど、リクエストに対して取得したその他すべての情報を入力します。
- リクエストをテストするには、「送信」をクリックします。
「レスポンス」セクションには、受信したデータが表示されます。
- 「レスポンス」セクションで、「例として保存」をクリックしてレスポンスを保存します。
新しい例が作成され、表示されます。 ワークスペースの上部にある「新規リクエスト」フィールドをクリックして、例の名前を変更します。
ヒント:
レスポンスを例として保存する前に、アダプタに適用できないプロパティを削除してレスポンスを形成します。 この情報は、Postmanコレクションをアダプタ定義ドキュメントに変換した後に削除することもできます。
- 左側のペインで、リクエスト・アイテムをクリックして「例」ページから「リクエスト」ページに戻り、「保存」をクリックしてリクエスト全体を保存します。
- Postmanコレクションをワークスペースにエクスポートします。
- 左ペインで、コレクションをポイントし、「他のアクションを表示」
をクリックしてから、表示されるメニューから「エクスポート」をクリックします。
- 「コレクションをエクスポート」ダイアログで、デフォルト・オプションを選択したままにして、「エクスポート」をクリックします。
- 「ファイルを保存するパスの選択」ウィンドウで、前にワークスペースとして選択および初期化したフォルダに移動します。 「Rapid Adapter BuilderのVS Code拡張機能の構成」を参照してください。 ワークスペース・フォルダで、「その他」ディレクトリを開き、「保存」をクリックしてファイルをこのディレクトリにエクスポートします。
Postmanコレクションは、<ApplicationName>_Adapter.postman_collection.jsonという名前のJSONファイルとして保存されます。
ノート:
Rapid Adapter Builderでコレクションをアダプタ定義ドキュメントに変換するには、Postmanコレクションのファイル名に常にサフィクス.postman_collectionが含まれている必要があります。