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

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

特定のゲートウェイレスポンスの GatewayResponse マッピングテンプレートを、キーと値のペアの文字列間マップとして定義します。キーと値のペアごとに、キーはコンテンツタイプ ("application/json" など) であり、値は単純に変数を置換する文字列化されたマッピングテンプレートです。GatewayResponse マッピングテンプレートは、Velocity Template Language (VTL) エンジンでは処理されません。

プロパティ

プロパティ名 タイプ 説明
content-type string

ゲートウェイレスポンス本文をカスタマイズする方法として単純な変数の置換のみをサポートする GatewayResponse 本文マッピングテンプレートです。

x-amazon-apigateway-gateway-responses.responseTemplates の例

次の Swagger の拡張例では、API Gateway で生成されたエラーレスポンスをアプリ固有の形式にカスタマイズする GatewayResponse マッピングテンプレートを示します。

Copy
"responseTemplates": { "application/json": "{ \"message\": $context.error.messageString, \"type\":$context.error.responseType, \"statusCode\": '488' } }

次の Swagger の拡張例では、API Gateway で生成されたエラーレスポンスを静的なエラーメッセージで上書きする GatewayResponse マッピングテンプレートを示します。

Copy
"responseTemplates": { "application/json": "{ \"message\": 'API-specific errors' }" } }