SDK 내보내기
    • PDF

    SDK 내보내기

    • PDF

    기사 요약

    Classic/VPC 환경에서 이용 가능합니다.

    배포된 API를 Swagger JSON 2.0, Open API JSON 3.0, Java SDK 형식으로 내보내기하여 다운로드합니다.

    요청

    요청 형식을 설명합니다. 요청 형식은 다음과 같습니다.

    메서드URI
    GET/products/{product-id}/apis/{api-id}/stages/{stage-id}/export

    요청 헤더

    API Gateway에서 공통으로 사용하는 헤더에 대한 자세한 내용은 API Gateway 요청 헤더를 참조해 주십시오.

    요청 경로 파라미터

    파라미터에 대한 설명은 다음과 같습니다.

    필드타입필수 여부설명
    product-idStringRequiredAPI가 속한 Product ID
    api-idStringRequired내보낼 API의 ID
    stage-idStringRequiredAPI가 배포된 스테이지 ID

    요청 쿼리 파라미터

    파라미터에 대한 설명은 다음과 같습니다.

    필드타입필수 여부설명
    platformStringOptional내려받을 Platform 파일 형식
    • SWAGGER_JSON (기본값) | OPENAPI3_JSON | JAVA_SDK
      • SWAGGER_JSON: Swagger JSON 2.0 형식
      • OPENAPI3_JSON: Open API JSON 3.0 형식
      • JAVA_SDK: Java SDK 형식
    packageNameStringOptional내보낼 Package 이름
    groupIdStringOptionalJAVA SDK 형식으로 내보내는 경우 Java의 Group ID 지정
    artifactIdStringOptionalJAVA SDK 형식으로 내보내는 경우 Java의 Artifact ID 지정
    artifactVersionStringOptionalJAVA SDK 형식으로 내보내는 경우 Java의 Artifact Version 지정
    licenseStringOptionalJAVA SDK 형식으로 내보내는 경우 Java의 License 지정
    versionStringOptionalJAVA SDK 형식으로 내보내는 경우 Java의 Version 지정

    요청 예시

    요청 예시는 다음과 같습니다.

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

    응답

    응답 형식을 설명합니다.

    응답 구문

    응답 구문은 다음과 같습니다.

    "Download File"
    

    응답 상태 코드

    API Gateway에서 공통으로 사용하는 응답 상태 코드에 대한 자세한 내용은 API Gateway 응답 상태 코드를 참조해 주십시오.

    응답 예시

    응답 예시는 다음과 같습니다.

    {
      "swagger" : "2.0",
      "info" : {
        "description" : "<br/>https://********o9.apigw.gov-ntruss.com/sample22/v1",
        "version" : "2024-05-02T07:35:04Z",
        "title" : "sample22"
      },
      "host" : "********o9.apigw.gov-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"
        }
      }
    }
    

    이 문서가 도움이 되었습니까?

    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.