MENU
      View published stage document

        View published stage document


        Article summary

        Available in Classic and VPC

        View published document of a specified stage.

        Request

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

        MethodURI
        GET/products/{product-id}/apis/{api-id}/stages/{stage-id}/swagger-json

        Request headers

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

        Request path parameters

        The following describes the parameters.

        FieldTypeRequiredDescription
        product-idStringRequiredProduct ID that the stage belongs to
        api-idStringRequiredID of the API that the stage belongs to
        stage-idStringRequiredID of the stage to view documents for

        Request example

        The following is a sample request.

        curl --location --request GET 'https://apigateway.apigw.ntruss.com/api/v1/products/***ksk9***/apis/***51hs***/stages/***5ei7***/swagger-json' \
        --header 'x-ncp-apigw-timestamp: {Timestamp}' \
        --header 'x-ncp-iam-access-key: {Access Key}' \
        --header 'x-ncp-apigw-signature-v2: {API Gateway Signature}'
        Curl

        Response

        The following describes the response format.

        Response syntax

        The response syntax is as follows.

        {
            "documentJson" : "documentJson"
        }
        JSON

        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.

        {
            "documentJson": "{\n  \"swagger\" : \"2.0\",\n  \"info\" : {\n    \"description\" : \"<br/>https://***ksk9***.apigw.ntruss.com/api000/stage\",\n    \"version\" : \"2024-05-08T02:32:42Z\",\n    \"title\" : \"api000\"\n  },\n  \"host\" : \"***ksk9***.apigw.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        (omitted) }\n  }\n}"
        }
        JSON

        Was this article helpful?

        Changing your password will log you out immediately. Use the new password to log back in.
        First name must have atleast 2 characters. Numbers and special characters are not allowed.
        Last name must have atleast 1 characters. Numbers and special characters are not allowed.
        Enter a valid email
        Enter a valid password
        Your profile has been successfully updated.