메서드 응답 추가
- 인쇄
- PDF
메서드 응답 추가
- 인쇄
- PDF
기사 요약
이 요약이 도움이 되었나요?
의견을 보내 주셔서 감사합니다.
Classic/VPC 환경에서 이용 가능합니다.
생성한 메서드의 응답 상태 코드를 정의하여 추가합니다.
요청
요청 형식을 설명합니다. 요청 형식은 다음과 같습니다.
메서드 | URI |
---|---|
POST | /products/{product-id}/apis/{api-id}/resources/{resource-id}/methods/{method-name}/responses |
요청 헤더
API Gateway에서 공통으로 사용하는 헤더에 대한 자세한 내용은 API Gateway 요청 헤더를 참조해 주십시오.
요청 경로 파라미터
파라미터에 대한 설명은 다음과 같습니다.
필드 | 타입 | 필수 여부 | 설명 |
---|---|---|---|
product-id | String | Required | API가 속한 Product ID
|
api-id | String | Required | 응답을 추가할 API의 ID
|
resource-id | String | Required | API 내 대상 리소스의 ID
|
method-name | String | Required | 대상 메서드 타입
|
요청 구문
요청 구문은 다음과 같습니다.
{
"responseDescription" : "responseDescription",
"statusCode" : 0
}
요청 바디
요청 바디에 대한 설명은 다음과 같습니다.
필드 | 타입 | 필수 여부 | 설명 |
---|---|---|---|
responseDescription | String | Optional | 응답에 대한 설명
|
statusCode | Integer | Required | 응답의 상태 코드
|
요청 예시
요청 예시는 다음과 같습니다.
curl --location --request POST 'https://apigateway.apigw.ntruss.com/api/v1/products/********o9/apis/cvcohvd2xj/resources/tf73xuex0v/methods/GET/responses' \
--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 '{
"responseDescription" : "Bad Request",
"statusCode" : 400
}'
응답
응답 형식을 설명합니다.
응답 구문
응답 구문은 다음과 같습니다.
{
"methodResponseDto" : {
"tenantId" : "tenantId",
"apiId" : "apiId",
"resourceId" : "resourceId",
"methodCode" : "methodCode",
"statusCode" : 0,
"responseDescription" : "responseDescription",
"modifier" : "modifier"
}
}
응답 상태 코드
API Gateway에서 공통으로 사용하는 응답 상태 코드에 대한 자세한 내용은 API Gateway 응답 상태 코드를 참조해 주십시오.
응답 예시
응답 예시는 다음과 같습니다.
{
"methodResponseDto": {
"tenantId": "********65ec41039ce6668c2058b8a9",
"apiId": "cvcohvd2xj",
"resourceId": "tf73xuex0v",
"methodCode": "0001",
"statusCode": 400,
"responseDescription": "Bad Request",
"modifier": "********-7fcd-11ec-a6ba-246e9659184c"
}
}
이 문서가 도움이 되었습니까?