View API document

Available in Classic and VPC

View the manual of an API deployed to a stage. It's only available for APIs you create yourself.

Request

The following describes the request format for the endpoint. The request format is as follows:

Request headers

For headers common to API Gateway, see API Gateway common request headers.

Request path parameters

The following describes the parameters.

Request example

The following is a sample request.

curl --location --request GET 'https://apigateway.apigw.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'

Response

The following describes the response format.

Response syntax

The response syntax is as follows.

{
  "apiId" : "apiId",
  "documentMd" : "documentMd",
  "tenantId" : "tenantId",
  "modifier" : "modifier"  
}

Response status codes

For response status codes common to API Gateway, see API Gateway response status codes.

Response example

The following is a sample response.

{
    "apiId": "cvcohvd2xj",
    "documentMd": "Manual of the API document",
    "tenantId": "********65ec41039ce6668c2058b8a9",
    "modifier": "********-7fcd-11ec-a6ba-246e9659184c"
}