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

API Gateway のゲートウェイレスポンス

ゲートウェイレスポンスは、API Gateway によって定義されたレスポンスタイプで識別されます。レスポンスは、HTTP ステータスコード、パラメータマッピングで指定される追加のヘッダーのセット、および VTL 以外のマッピングテンプレートで生成されるペイロードで構成されます。

API Gateway REST API では、ゲートウェイレスポンスは GatewayResponse によって表されます。Swagger では、GatewayResponse インスタンスは x-amazon-apigateway-gateway-responses.gatewayResponse 拡張子で記述されます。

ゲートウェイレスポンスを有効にするには、API レベルでサポートされているレスポンスタイプのゲートウェイレスポンスを設定します。API Gateway から該当タイプのレスポンスが返されるたびに、ゲートウェイレスポンスに定義されているヘッダーマッピングとペイロードマッピングテンプレートに適用されてマッピングされた結果が API 発信者に返されます。

次のセクションでは、API Gateway コンソールと API Gateway REST API を使用してゲートウェイレスポンスを設定する方法を示します。