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

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

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

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

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

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

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