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

x-amazon-apigateway-integration.response オブジェクト

レスポンスを定義し、統合レスポンスからメソッドレスポンスまでパラメーターマッピングまたはペイロードマッピングを指定します。

プロパティ

プロパティ名 タイプ 説明
statusCode string

メソッドレスポンスの HTTP ステータスコード (例: "200")。これは、Swagger Operation responses フィールドで一致しているレスポンスに対応している必要があります。

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

レスポンスのペイロード用に MIME タイプ固有のマッピングテンプレートを指定します。

responseParameters x-amazon-apigateway-integration.responseParameters オブジェクト

レスポンス用にパラメーターマッピングを指定します。メソッドの header パラメーターにマッピングできるのは、統合レスポンスの header パラメーターおよび body パラメーターだけです。

contentHandling string レスポンスのペイロードエンコード変換タイプ。有効な値は、1) バイナリペイロードを Base64 でエンコードされた文字列に変換する場合、テキストペイロードを utf-8 でエンコードされた文字列に変換する場合、または変更なしでテキストペイロードをネイティブに渡す場合は CONVERT_TO_TEXT、2) テキストペイロードを Base64 でデコードされた BLOB に変換する場合、または変更なしでバイナリペイロードをネイティブに渡す場合は CONVERT_TO_BINARY です。

x-amazon-apigateway-integration.response

次の例では、バックエンドから application/json または application/xml の MIME タイプのペイロードを派生させるメソッド用の 302 レスポンスが定義されています。このレスポンスでは、指定のマッピングテンプレートが使用され、メソッドの Location ヘッダーで統合レスポンスからのリダイレクト URL が返されます。

Copy
{ "statusCode" : "302", "responseTemplates" : { "application/json" : "#set ($root=$input.path('$')) { \"stage\": \"$root.name\", \"user-id\": \"$root.key\" }", "application/xml" : "#set ($root=$input.path('$')) <stage>$root.name</stage> " }, "responseParameters" : { "method.response.header.Location": "integration.response.body.redirect.url" } }