Export SDK

Available in Classic and VPC

Export and download a deployed API in Swagger JSON 2.0, Open API JSON 3.0, and Java SDK formats.

Request

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

Request headers

For information about the headers common to all API Gateway APIs, see API Gateway request headers.

Request path parameters

You can use the following path parameters with your request:

Request query parameters

You can use the following query parameters with your request:

Request example

The following is a sample request.

curl --location --request GET 'https://apigateway.apigw.ntruss.com/api/v1/products/********o9/apis/cvcohvd2xj/stages/y7ri4o8kia/export?platform=SWAGGER_JSON&packageName=package01' \
--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.

"Download File"

Response status codes

For information about the HTTP status codes common to all API Gateway APIs, see API Gateway response status codes.

Response example

The following is a sample response.

{
  "swagger" : "2.0",
  "info" : {
    "description" : "<br/>https://********o9.apigw.ntruss.com/sample22/v1",
    "version" : "2024-05-02T07:35:04Z",
    "title" : "sample22"
  },
  "host" : "********o9.apigw.ntruss.com",
  "basePath" : "/sample22/v1",
  "schemes" : [ "https" ],
  "paths" : {
    "/" : { },
    "/apigw" : { },
    "/apigw/v1" : { },
    "/apigw/v1/api-keys" : {
      "get" : {
        "tags" : [ "v1" ],
        "description" : "demo /apigw/v1/api-keys",
        "consumes" : [ "application/json", "text/plain" ],
        "produces" : [ "application/json", "text/plain" ],
        "parameters" : [ {
          "name" : "x_header",
          "in" : "header",
          "description" : "header 1",
          "required" : true,
          "type" : "string",
          "x-ncp-parameter-is-logged" : false
        }, {
          "name" : "name",
          "in" : "query",
          "description" : "name desc",
          "required" : false,
          "type" : "string",
          "x-ncp-parameter-is-logged" : false
        } ],
        "responses" : {
          "200" : {
            "description" : "",
            "headers" : {
              "x_header" : {
                "type" : "string",
                "description" : "ok"
              }
            },
            "schema" : {
              "$ref" : "#/definitions/ApiKeyDto"
            }
          },
          "404" : {
            "description" : "not found"
          }
        },
        "x-ncp-apigw-use-body-when-formdata" : false,
        "x-ncp-apigateway-filters" : {
          "valid" : {
            "type" : "NONE"
          },
          "apiKey" : {
            "required" : false
          },
          "auth" : {
            "platform" : "NONE"
          }
        },
        "x-ncp-apigateway-endpoint" : {
          "MOCK" : {
            "httpStatus" : 200,
            "response" : "12121",
            "headers" : {
              "mock-header" : "header value"
            }
          }
        }
      },
      "post" : {
        "tags" : [ "v1" ],
        "description" : "demo post /apigw/v1/api-keys",
        "consumes" : [ "application/json" ],
        "produces" : [ "application/json" ],
        "parameters" : [ {
          "in" : "body",
          "name" : "apiKey",
          "description" : "request body",
          "required" : true,
          "schema" : {
            "$ref" : "#/definitions/ApiKeyDto"
          }
        } ],
        "responses" : {
          "200" : {
            "description" : "",
            "headers" : {
              "x_header" : {
                "type" : "string",
                "description" : "ok"
              }
            },
            "schema" : {
              "$ref" : "#/definitions/ApiKeyDto"
            }
          },
          "404" : {
            "description" : "not found"
          }
        },
        "x-ncp-apigw-use-body-when-formdata" : false,
        "x-ncp-apigateway-filters" : {
          "valid" : {
            "type" : "NONE"
          },
          "apiKey" : {
            "required" : false
          },
          "auth" : {
            "platform" : "NONE"
          }
        },
        "x-ncp-apigateway-endpoint" : {
          "HTTP" : {
            "method" : "POST",
            "url" : "/api-keys",
            "stream" : false
          }
        }
      }
    },
    "/apigw/v1/apis" : {
      "get" : {
        "tags" : [ "v1" ],
        "description" : "demo apigw/v1/apis",
        "consumes" : [ "application/json" ],
        "produces" : [ "text/plain" ],
        "parameters" : [ ],
        "responses" : {
          "200" : {
            "description" : "",
            "headers" : {
              "x_header" : {
                "type" : "string",
                "description" : "ok"
              }
            },
            "schema" : {
              "$ref" : "#/definitions/ApiKeyDto"
            }
          },
          "404" : {
            "description" : "not found"
          }
        },
        "x-ncp-apigw-use-body-when-formdata" : false,
        "x-ncp-apigateway-filters" : {
          "valid" : {
            "type" : "NONE"
          },
          "apiKey" : {
            "required" : false
          },
          "auth" : {
            "platform" : "NONE"
          }
        },
        "x-ncp-apigateway-endpoint" : {
          "MOCK" : {
            "httpStatus" : 200,
            "response" : "11111",
            "headers" : {
              "mock-header" : "header value"
            }
          }
        }
      }
    }
  },
  "definitions" : {
    "ApiKeyDto" : {
      "type" : "object",
      "properties" : {
        "apiKeyDescription" : {
          "type" : "string"
        },
        "apiKeyId" : {
          "type" : "string"
        },
        "apiKeyName" : {
          "type" : "string"
        }
      },
      "description" : "demo model",
      "x-ncp-model-description" : "demo model"
    }
  }
}