x-amazon-apigateway-gateway-responses.gatewayResponse 객체

상태 코드, 적용 가능한 응답 파라미터 또는 응답 템플릿을 포함하여 지정된 응답 유형의 게이트웨이 응답을 정의합니다.

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\" }"
      }
    }