게이트웨이 응답 템플릿 수정
- 인쇄
- PDF
게이트웨이 응답 템플릿 수정
- 인쇄
- PDF
기사 요약
이 요약이 도움이 되었나요?
의견을 보내 주셔서 감사합니다.
Classic/VPC 환경에서 이용 가능합니다.
게이트웨이 응답의 본문으로 매핑될 템플릿의 내용을 수정합니다.
요청
요청 형식을 설명합니다. 요청 형식은 다음과 같습니다.
메서드 | URI |
---|---|
PATCH | /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 | 수정하려는 템플릿의 내용 |
contentType | String | Required | 콘텐츠 타입
|
요청 예시
요청 예시는 다음과 같습니다.
curl --location --request PATCH '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\" : \"${context.apiName}\" }",
"contentType" : "application/json"
}'
응답
응답 형식을 설명합니다.
응답 상태 코드
API Gateway API에서 공통으로 사용하는 응답 상태 코드에 대한 자세한 내용은 API Gateway 응답 상태 코드를 참조해 주십시오.
이 문서가 도움이 되었습니까?