x-amazon-apigateway-gateway-responses.gatewayResponse 对象
定义了给定响应类型的网关响应，包括状态代码、任何适用的响应参数或响应模板。
属性 | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| 属性名称 | 类型 | 说明 | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
x-amazon-apigateway-gateway-responses.responseParameters |
指定 GatewayResponse 参数，即标头参数。参数值可以采用任何传入请求参数值或静态自定义值。 |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
x-amazon-apigateway-gateway-responses.responseTemplates |
指定网关响应的映射模板。这些模板不由 VTL 引擎处理。 |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
string |
网关响应的 HTTP 状态代码。 |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
x-amazon-apigateway-gateway-responses.gatewayResponse 示例
以下基于 OpenAPI 的 API Gateway 扩展示例定义了 GatewayResponse 来自定义 INVALID_API_KEY 响应，以返回状态代码 456、传入请求的 api-key 标头值以及 "Bad api-key" 消息。
"INVALID_API_KEY": { "statusCode": "456", "responseParameters": { "gatewayresponse.header.api-key": "method.request.header.api-key" }, "responseTemplates": { "application/json": "{\"message\": \"Bad api-key\" }" } }