Classic/VPC 환경에서 이용 가능합니다.
지정한 Stage의 전체 문서를 조회합니다.
요청
요청 형식을 설명합니다. 요청 형식은 다음과 같습니다.
| 메서드 | URI |
|---|---|
| GET | /products/{product-id}/apis/{api-id}/stages/{stage-id}/deployments/{deployment-no} |
요청 헤더
API Gateway에서 공통으로 사용하는 헤더에 대한 자세한 내용은 API Gateway 요청 헤더를 참조해 주십시오.
요청 경로 파라미터
파라미터에 대한 설명은 다음과 같습니다.
| 필드 | 타입 | 필수 여부 | 설명 |
|---|---|---|---|
product-id |
String | Required | Stage가 속한 Product ID
|
api-id |
String | Required | Stage가 속한 API ID
|
stage-id |
String | Required | 문서를 조회할 Stage ID
|
deployment-no |
Long | Required | 문서를 조회할 Stage의 Deployment 번호
|
요청 예시
요청 예시는 다음과 같습니다.
curl --location --request GET 'https://apigateway.apigw.gov-ntruss.com/api/v1/products/***ksk9***/apis/***51hs***/stages/***5ei7***/deployments/251***' \
--header 'x-ncp-apigw-timestamp: {Timestamp}' \
--header 'x-ncp-iam-access-key: {Access Key}' \
--header 'x-ncp-apigw-signature-v2: {API Gateway Signature}'
응답
응답 형식을 설명합니다.
응답 구문
응답 구문은 다음과 같습니다.
{
"documentJson" : "documentJson"
}
응답 상태 코드
API Gateway에서 공통으로 사용하는 응답 상태 코드에 대한 자세한 내용은 API Gateway 응답 상태 코드를 참조해 주십시오.
응답 예시
응답 예시는 다음과 같습니다.
{
"documentJson": "{\n \"swagger\" : \"2.0\",\n \"info\" : {\n \"description\" : \"<br/>https://***ksk9***.apigw.gov-ntruss.com/api000/stage\",\n \"version\" : \"2024-05-08T02:38:43Z\",\n \"title\" : \"api000\"\n },\n \"host\" : \"***ksk9***.apigw.gov-ntruss.com\",\n \"basePath\" : \"/api000/stage\",\n \"schemes\" : [ \"https\" ],\n \"paths\" : {\n \"/\" : {\n \"get\" : {\n \"tags\" : [ \"stage\" ],\n \"description\" : \"\",\n \"parameters\" : [ ],\n \"responses\" : {\n \"200\" : {\n \"description\" : \"default\"\n }\n (생략) }\n }\n}"
}