メニュー
Amazon API Gateway
開発者ガイド

x-amazon-apigateway-gateway-responses オブジェクト

API のゲートウェイレスポンスを、キーと値のペアの string-to-GatewayResponse マップとして定義します。

プロパティ

プロパティ名 タイプ 説明
responseType x-amazon-apigateway-gateway-responses.gatewayResponse

指定した responseTypeGatewayResponseです。

x-amazon-apigateway-gateway-responses の例

次の例の Swagger に対する API Gateway 拡張では、2 つの GatewayResponse インスタンス (1 つは DEFAULT_4XX タイプ、もう 1 つは INVALID_API_KEY タイプ) を含む GatewayResponses マップを定義しています。

Copy
"{ x-amazon-apigateway-gateway-responses": { "DEFAULT_4XX": { "responseParameters": { "gatewayresponse.header.Access-Control-Allow-Origin": "'domain.com'" }, "responseTemplates": { "application/json": "{\"message\": test 4xx b }" } }, "INVALID_API_KEY": { "statusCode": "429", "responseTemplates": { "application/json": "{\"message\": test forbidden }" } } } }