MENU
      Export SDK

        Export SDK


        Article summary

        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:

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

        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 API belongs to
        api-idStringRequiredID of the API whose document you want to export
        stage-idStringRequiredStage ID where the API is deployed

        Request query parameters

        The following describes the parameters.

        FieldTypeRequiredDescription
        platformStringOptionalPlatform file format to download
        • SWAGGER_JSON (default) | OPENAPI3_JSON | JAVA_SDK
          • SWAGGER_JSON: Swagger JSON 2.0 format
          • OPENAPI3_JSON: Open API JSON 3.0 format
          • JAVA_SDK: Java SDK format
        packageNameStringOptionalName of package to export
        groupIdStringOptionalSpecify group ID in Java when exporting to Java SDK format
        artifactIdStringOptionalSpecify artifact ID in Java when exporting to Java SDK format
        artifactVersionStringOptionalSpecify artifact version in Java when exporting to Java SDK format
        licenseStringOptionalSpecify Java license when exporting to Java SDK format
        versionStringOptionalSpecify Java version when exporting to Java SDK format

        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'
        Curl

        Response

        The following describes the response format.

        Response syntax

        The response syntax is as follows.

        "Download File"
        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.

        {
          "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"
            }
          }
        }
        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.