ポータルで API Gateway 製品 REST エンドポイントの「試してみる」を有効にする - Amazon API Gateway
考慮事項製品 REST エンドポイントの [試してみる] を有効にする

ポータルで API Gateway 製品 REST エンドポイントの「試してみる」を有効にする

[試してみる] を使用すると、API コンシューマーがポータルから製品エンドポイントを呼び出せるようになります。API コンシューマーが [試してみる] を使用する場合、メソッドリクエストパラメータを入力し、製品エンドポイントを呼び出します。次に、API Gateway はパブリックインターネット経由で API を呼び出し、[試してみる] ウィンドウでレスポンスを返します。カスタム製品ページを使用して、API にアクセスするために必要なパラメータに関する追加情報を提供できます。

API Gateway は、API を保護するために次の制限を使用します。

  • API Gateway は、API への 1 秒あたり 3 つのリクエストのみを許可します。

  • API Gateway は、29,000 ミリ秒の組み込みタイムアウト制限を使用します。実際の API ではより高いタイムアウト制限が設定されている場合がありますが、お客様が [試してみる] を使用する場合、API Gateway はこのタイムアウトを適用しません。

  • API Gateway はレスポンスペイロードを 6MB に制限します。

考慮事項

以下の考慮事項は、[試してみる] の使用方法に影響する可能性があります。

  • ポータルをプレビューする場合、[試してみる] はサポートされません。

  • 次の機能を備えた REST API では、[試してみる] はサポートされていません。

    • プライベート API

    • 相互 TLS を使用する API

    • プライベートまたは自己署名 SSL 証明書を使用する API

    ポータル所有者は、API コンシューマーとの通信に責任があるため、サポートされていない REST API では、[試してみる] ボタンが表示されません。API Gateway ではこれについて説明しません。

製品 REST エンドポイントの [試してみる] を有効にする

次の手順は、製品エンドポイントで [試してみる] を有効にする方法を示しています。

ポータルで [試してみる] を使用する方法については、「API Gateway ポータルを使用する」を参照してください。

製品 REST エンドポイントの [試してみる] を有効にする

  1. メインナビゲーションペインで、[ポータル製品] を選択します。

  2. [製品] を選択します。

  3. [ドキュメント] タブの [API リファレンスページ] で、[/dogs - GET] などの製品 REST エンドポイントの名前を選択します。

  4. [ページを編集] を選択します。

  5. 顧客がポータルで API を呼び出せるようにするには、[試してみる機能] を選択します。

  6. [Save changes] (変更の保存) をクリックします。

  7. 変更を有効にするには、このポータル製品を使用するポータルを再公開する必要があります。