Classic/VPC 환경에서 이용 가능합니다.
배포한 API 설명서의 내용을 수정합니다. 직접 생성한 API에서만 사용할 수 있습니다.
요청
요청 형식을 설명합니다. 요청 형식은 다음과 같습니다.
| 메서드 | URI |
|---|---|
| PATCH | /products/{product-id}/apis/{api-id}/documents |
요청 헤더
API Gateway에서 공통으로 사용하는 헤더에 대한 자세한 내용은 API Gateway 요청 헤더를 참조해 주십시오.
요청 경로 파라미터
파라미터에 대한 설명은 다음과 같습니다.
| 필드 | 타입 | 필수 여부 | 설명 |
|---|---|---|---|
product-id |
String | Required | API가 속한 Product ID
|
api-id |
String | Required | 문서를 수정할 API의 ID
|
요청 구문
요청 구문은 다음과 같습니다.
{
"documentMd" : "string"
}
요청 바디
요청 바디에 대한 설명은 다음과 같습니다.
| 필드 | 타입 | 필수 여부 | 설명 |
|---|---|---|---|
documentMd |
String | Required | API 설명서의 내용 |
요청 예시
요청 예시는 다음과 같습니다.
curl --location --request PATCH 'https://apigateway.apigw.gov-ntruss.com/api/v1/products/w1k03m9zo9/apis/cvcohvd2xj/documents' \
--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 '{
"documentMd" : "API 문서의 설명서"
}'
응답
응답 형식을 설명합니다.
응답 상태 코드
API Gateway에서 공통으로 사용하는 응답 상태 코드에 대한 자세한 내용은 API Gateway 응답 상태 코드를 참조해 주십시오.