

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

# x-amazon-apigateway-gateway-responses.gatewayResponse 物件
<a name="api-gateway-swagger-extensions-gateway-responses.gatewayResponse"></a>

定義指定回應類型的閘道回應，包括狀態碼、任何適用的回應參數，或回應範本。


| 屬性名稱 | 類型 | 描述 | 
| --- | --- | --- | 
| responseParameters | [x-amazon-apigateway-gateway-responses.responseParameters](api-gateway-swagger-extensions-gateway-responses.responseParameters.md) |  指定 [GatewayResponse](https://docs.aws.amazon.com/apigateway/latest/api/API_GatewayResponse.html) 參數，即標頭參數。該參數值可使用任何傳入[請求參數](rest-api-parameter-mapping.md)值或靜態自訂值。  | 
| responseTemplates | [x-amazon-apigateway-gateway-responses.responseTemplates](api-gateway-swagger-extensions-gateway-responses.responseTemplates.md) |  指定閘道回應的對應範本。該範本不由 VTL 引擎處理。  | 
| statusCode | string |  閘道回應的 HTTP 狀態碼。  | 

## x-amazon-apigateway-gateway-responses.gatewayResponse 範例
<a name="api-gateway-swagger-extensions-gateway-responses.gatewayResponse-example"></a>

 下列 OpenAPI 的 API Gateway 延伸範例會定義 [GatewayResponse](https://docs.aws.amazon.com/apigateway/latest/api/API_GatewayResponse.html)，以自訂 `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\" }"
      }
    }
```