x-amazon-apigateway-gateway-responses 객체

API에 대한 게이트웨이 응답을 키-값 페어의 GatewayResponse 맵에 대한 문자열로 정의합니다. 확장은 루트 수준 OpenAPI 구조에 적용됩니다.

속성 이름	유형	설명
responseType	x-amazon-apigateway-gateway-responses.gatewayResponse	지정된 responseType에 대한 GatewayResponse입니다.

x-amazon-apigateway-gateway-responses 예제

다음과 같은 OpenAPI에 대한 API Gateway 확장 예제에서는 두 개의 GatewayResponse 인스턴스를 포함하는 GatewayResponses 맵을 정의합니다. 하나는 DEFAULT_4XX 유형용이고, 다른 하나는 INVALID_API_KEY 유형용입니다.

{
  "x-amazon-apigateway-gateway-responses": {
    "DEFAULT_4XX": {
      "responseParameters": {
        "gatewayresponse.header.Access-Control-Allow-Origin": "'domain.com'"
      },
      "responseTemplates": {
        "application/json": "{\"message\": test 4xx b }"
      }
    },
    "INVALID_API_KEY": {
      "statusCode": "429",
      "responseTemplates": {
        "application/json": "{\"message\": test forbidden }"
      }
    }
  }
}