Amazon API Gateway
开发人员指南
AWS 文档中描述的 AWS 服务或功能可能因区域而异。要查看适用于中国区域的差异,请参阅中国的 AWS 服务入门

x-amazon-apigateway-integration.responses 对象

定义方法的响应,并指定从集成响应到方法响应的参数映射或负载映射。

属性

属性名称 类型 描述
响应状态模式 x-amazon-apigateway-integration.response 对象

选择用于匹配集成响应与方法响应的正则表达式。对于 HTTP 集成,该正则表达式适用于集成响应状态代码。对于 Lambda 调用,当 Lambda 函数执行发生异常时,该正则表达式适用于 AWS Lambda 作为失败响应正文返回的错误信息对象的 errorMessage 字段。

注意

响应状态模式属性名称是指响应状态代码或描述一组响应状态代码的正则表达式。它不对应 API Gateway REST API 中 IntegrationResponse 资源的任意标识符。

x-amazon-apigateway-integration.responses 示例

下面的示例显示了一列 2xx 响应和 302 响应。对于 2xx 响应,从 application/jsonapplication/xml MIME 类型的集成响应负载映射方法响应。此响应使用提供的映射模板。对于 302 响应,方法响应会返回一个 Location 标头,该标头的值是由集成响应负载上的 redirect.url 属性派生出来的。

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