게이트웨이 응답 템플릿 추가

Prev Next

Classic/VPC 환경에서 이용 가능합니다.

게이트웨이 응답 본문으로 반환될 매핑 템플릿을 정의하여 추가합니다.

요청

요청 형식을 설명합니다. 요청 형식은 다음과 같습니다.

메서드 URI
POST /products/{product-id}/apis/{api-id}/responses/{response-type}/templates

요청 헤더

API Gateway에서 공통으로 사용하는 헤더에 대한 자세한 내용은 API Gateway 요청 헤더를 참조해 주십시오.

요청 경로 파라미터

파라미터에 대한 설명은 다음과 같습니다.

필드 타입 필수 여부 설명
product-id String Required API가 속한 Product ID
api-id String Required 매핑 템플릿을 추가할 API의 ID
response-type String Required 게이트웨이 응답의 유형

요청 구문

요청 구문은 다음과 같습니다.

{
  "mappingTemplate" : "mappingTemplate",
  "contentType" : "contentType"
}

요청 바디

요청 바디에 대한 설명은 다음과 같습니다.

필드 타입 필수 여부 설명
mappingTemplate String Required 추가하려는 템플릿의 내용
  • 1~500자
contentType String Required 콘텐츠 타입
  • HTTP의 Content-Type 헤더에 상응하는 값
  • 1~100자
  • <예시> application/json, application/xml, text/plain

요청 예시

요청 예시는 다음과 같습니다.

curl --location --request POST 'https://apigateway.apigw.gov-ntruss.com/api/v1/products/********o9/apis/cvcohvd2xj/responses/AUTHENTICATION_FAILED/templates' \
--header 'x-ncp-apigw-timestamp: {Timestamp}' \
--header 'x-ncp-iam-access-key: {Access Key}' \
--header 'x-ncp-apigw-signature-v2: {API Gateway Signature}' \
--header 'Content-Type: application/json' \
--data '{
  "mappingTemplate" : "{ \"error\": \"authentication error\" }",
  "contentType" : "application/json"
}'

응답

응답 형식을 설명합니다.

응답 구문

응답 구문은 다음과 같습니다.

{
  "apiId" : "apiId",
  "responseType" : "responseType",
  "contentType" : "contentType",
  "mappingTemplate" : "mappingTemplate" 
}

응답 상태 코드

API Gateway API에서 공통으로 사용하는 응답 상태 코드에 대한 자세한 내용은 API Gateway 응답 상태 코드를 참조해 주십시오.

응답 예시

응답 예시는 다음과 같습니다.

{
    "apiId": "cvcohvd2xj",
    "responseType": "AUTHENTICATION_FAILED",
    "contentType": "application/json",
    "mappingTemplate": "{ \"error\": \"authentication error\" }"
}