x-amazon-apigateway-integration. 回應物件 - Amazon API Gateway

本文為英文版的機器翻譯版本,如內容有任何歧義或不一致之處,概以英文版為準。

x-amazon-apigateway-integration. 回應物件

定義回應,並指定從整合回應到方法回應的參數對應或承載對應。

屬性名稱 類型 描述
statusCode string

HTTP方法回應的狀態碼;例如,"200". 這必須對應於「開啟API作業responses」欄位中的相符回應。

responseTemplates x-amazon-apigateway-integration。 responseTemplates 物件

指定回應裝載的MIME特定類型對應範本。

responseParameters x-amazon-apigateway-integration。 responseParameters 物件

指定回應的參數對應。只有整合回應的 headerbody 參數可以對應到方法的 header 參數。

contentHandling string 回應承載編碼轉換類型。有效值為 1) CONVERT_TO_TEXT,將二進位承載轉換為 base64 編碼的字串或將文字承載轉換為 utf-8 編碼的字串,或以原生方式傳遞文字承載,不予修改;和 2) CONVERT_TO_BINARY,將文字承載轉換為 Base64 編碼的 blob,或以原生方式傳遞二進位承載,不予修改。

x-amazon-apigateway-integration.response 範例

下列範例會定義從後端衍生application/jsonapplication/xmlMIME類型裝載之方法的302回應。該響應使用提供的映射模板,並URL從方法的Location頭集成響應返回重定向。

{ "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" } }