新しいAPIプロキシエンドポイントの設定 ​

詳細タブには、プロキシワークフローの次のコンポーネントの設定が要約されます:

プロキシベースのエンドポイントの詳細タブを表示

• 新しいAPIプロキシリクエストトリガー

• 受信リクエストのスキーマを定義します。これには、コンテンツタイプ、クエリパラメータ、本文、ヘッダー、および想定されるレスポンススキーマが含まれます。

• ターゲットにリクエストを転送アクション

• デフォルトでは、すべてのプロキシエンドポイントがターゲットAPIにリクエストを転送します。 必要に応じて、ターゲットAPIエンドポイントに転送する前に、ヘッダー、クエリパラメータ、リクエスト本文などの受信リクエストデータを変換できます。 リクエストの変換方法については、APIプロキシ変換ガイドを参照してください。

• レスポンスを返すアクション

• クライアントに送信されるレスポンスを設定します。これには、コンテンツタイプ、ヘッダー、HTTPステータスコード、本文が含まれます。 クライアントに送信する前にデータを変更して、レスポンスを変換することもできます。

エンドポイントを手動で作成した場合、またはコレクションの作成時に手動設定を選択した場合は、スキーマとヘッダーを設定する必要があります。 詳細については、スキーマの設定を参照してください。

コレクションの作成時にOpenAPI仕様をインポートした場合、各エンドポイントのスキーマとヘッダーは事前に設定されています。

ターゲットURLセクションには、プロキシエンドポイントへのリクエストの転送先アドレスが表示されます。 ターゲットURLは、APIプロキシコレクション設定で関連付けられたHTTPコネクションを変更することで変更できます。

テストリクエストタブでは、サンプルリクエストを送信してレスポンスを確認することで、プロキシエンドポイントをテストできます。

プロキシベースのエンドポイントのテストタブを表示

このタブには、次のセクションがあります:

• パラメーター

• エンドポイントに必要なクエリパラメータ、ヘッダー、およびリクエスト本文を一覧表示します。

• レスポンス

• クライアントに想定されるHTTPステータスコードとレスポンススキーマを表示します。

設定タブでは、プロキシエンドポイントの詳細を更新できます。 たとえば、特定のAPI要件に合わせてリクエストタイムアウトを調整したり、整理しやすいようにエンドポイントの名前を変更したりできます。

プロキシベースのエンドポイントの設定タブを表示

Settings（設定）タブには、次のフィールドが含まれます:

• HTTPメソッド

• エンドポイントで使用するHTTPメソッドを選択します。

• エンドポイント名

• エンドポイントのわかりやすい名前を入力します。

• エンドポイントパス

• エンドポイントパスを入力します。これにはパスパラメータを含めることができます。 エンドポイントパスがエンドポイントパスのガイドラインに従っていることを確認します。

• エンドポイントの説明

• エンドポイントの説明を入力します。

• リクエストタイムアウト

• リクエストタイムアウト期間を入力します: 30秒（デフォルト）、240秒（最大）。

• ベースURLを保持

• エンドポイントパスを追加せずに、リクエストをコネクションのベースURLに直接転送するかどうかを切り替えます。

• レスポンスをキャッシュ

• レスポンスをキャッシュトグルをクリックしてキャッシュを有効にします。 このオプションはGETメソッドでのみ使用できます。

  • Time-to-live期間

  • 必須。 レスポンスが更新または削除されるまでキャッシュに保存される期間を秒単位で入力します。 デフォルト値は600秒、最大値は3600秒です。

  • キャッシュキーパラメータ

  • 任意です。 必要に応じて、キャッシュキーに含める追加パラメータを定義します。 キャッシュキーは常にエンドポイントURLで始まります。 詳細については、APIエンドポイントのキャッシュを参照してください。

このタブで直接変更を行い、保存をクリックして適用できます。