Amazon API Gateway
開発者ガイド

Swagger でゲートウェイレスポンスのカスタマイズを設定する

API ルートレベルで x-amazon-apigateway-gateway-responses 拡張子を使用し、Swagger でゲートウェイレスポンスをカスタマイズできます。次の Swagger の定義は、MISSING_AUTHENTICATION_TOKEN タイプの GatewayResponse をカスタマイズする例を示しています。

"x-amazon-apigateway-gateway-responses": { "MISSING_AUTHENTICATION_TOKEN": { "statusCode": 404, "responseParameters": { "gatewayresponse.header.x-request-path": "method.input.params.petId", "gatewayresponse.header.x-request-query": "method.input.params.q", "gatewayresponse.header.Access-Control-Allow-Origin": "'a.b.c'", "gatewayresponse.header.x-request-header": "method.input.params.Accept" }, "responseTemplates": { "application/json": "{\n \"message\": $context.error.messageString,\n \"type\": \"$context.error.responseType\",\n \"stage\": \"$context.stage\",\n \"resourcePath\": \"$context.resourcePath\",\n \"stageVariables.a\": \"$stageVariables.a\",\n \"statusCode\": \"'404'\"\n}" } }

この例では、カスタマイズによってステータスコードをデフォルト (403) から 404 に変更します。また、ゲートウェイレスポンスに 4 つのヘッダーパラメータと、application/json メディアタイプの 1 つの本文マッピングテンプレートを追加します。