API Gateway でペイロードレスポンスストリーミングと HTTP プロキシ統合を設定する

https://console.aws.amazon.com/apigateway で API Gateway コンソールにサインインします。

REST API を選択します。

[リソースの作成] を選択します。

[リソース名] に streaming と入力します。

[リソースの作成] を選択します。

[/streaming] リソースを選択した状態で、[メソッドを作成] を選択します。

[メソッドタイプ] で、[任意] を選択します。

[統合タイプ] で､ [HTTP] を選択します｡

[HTTP プロキシ統合] を選択します。

[レスポンス転送モード] で、[ストリーム] を選択します。

[HTTP メソッド] の場合は、メソッドを選択します。

[エンドポイント URL] には、統合エンドポイントを入力します。ストリーミングで返される大きなペイロードを生成するエンドポイントを必ず選択してください。

[メソッドの作成] を選択します。

[API のデプロイ] を選択します。

[ステージ] で [新規ステージ] を選択します。

[Stage name (ステージ名)] に prod と入力します。

(オプション) [説明] に説明を入力します。

[デプロイ] をクリックします。

以下の Open API ファイルをコピーし、ResponseStreamDemoSwagger.yaml として保存します。このファイルでは、responseTransferMode は STREAM に設定されます。統合エンドポイントは https://example.com に設定されていますが、大きなペイロードを生成するエンドポイントに変更して再ストリーミングすることをお勧めします。

openapi: "3.0.1"
info:
  title: "ResponseStreamingDemo"
  version: "2025-04-28T17:28:25Z"
servers:
- url: "{basePath}"
  variables:
    basePath:
      default: "prod"
paths:
  /streaming:
    get:
      x-amazon-apigateway-integration:
        httpMethod: "GET"
        uri: "https://example.com"
        type: "http_proxy"
        timeoutInMillis: 900000
        responseTransferMode: "STREAM"

次の import-rest-api コマンドを使用して、OpenAPI 定義をインポートします。

aws apigateway import-rest-api \
  --body 'fileb://~/ResponseStreamDemoSwagger.yaml' \
  --parameters endpointConfigurationTypes=REGIONAL \
  --region us-west-1

次の create-deployment コマンドを使用して、新しい API をステージにデプロイします。

aws apigateway create-deployment \
  --rest-api-id a1b2c3 \
  --stage-name prod \
  --region us-west-1

https://console.aws.amazon.com/apigateway で API Gateway コンソールにサインインします。

REST API を選択します。

メソッドを選択します。

[統合リクエスト] タブの [統合リクエストの設定] で、[編集] を選択します。

[レスポンス転送モード] で、[ストリーム] を選択します。

[保存] を選択します。

[API のデプロイ] を選択します。

[ステージ] で [新規ステージ] を選択します。

[Stage name (ステージ名)] に prod と入力します。

(オプション) [説明] に説明を入力します。

[デプロイ] をクリックします。