SDKのエクスポート

Classic/VPC環境で利用できます。

デプロイされた APIを Swagger JSON 2.0、Open API JSON 3.0、Java SDK形式でエクスポートしてダウンロードします。

リクエスト

リクエスト形式を説明します。リクエスト形式は次の通りです。

リクエストヘッダ

API Gatewayで共通して使用されるヘッダの詳細は、API Gatewayのリクエストヘッダをご参照ください。

リクエストパスパラメータ

パラメータの説明は次の通りです。

リクエストクエリパラメータ

パラメータの説明は次の通りです。

リクエスト例

リクエストのサンプルコードは次の通りです。

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'

レスポンス

レスポンス形式を説明します。

レスポンス構文

レスポンス構文は次の通りです。

"Download File"

レスポンスステータスコード

API Gatewayで共通して使用されるレスポンスステータスコードの詳細は、API Gatewayのレスポンスステータスコードをご参照ください。

レスポンス例

レスポンスのサンプルコードは次の通りです。

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