x-amazon-apigateway-integration.reponses 对象 - Amazon API Gateway

本文属于机器翻译版本。若本译文内容与英语原文存在差异,则一律以英文原文为准。

x-amazon-apigateway-integration.reponses 对象

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

属性
属性名称 类型 说明
响应状态模式 x-amazon-apigateway-integration。响应对象

可以是用于将集成响应与方法响应匹配的正则表达式,或者用于捕获尚未配置的任何响应的 default。对于 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" } } }