Canary Swagger Jsonの照会

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

Canaryに公開された API文書内容を Swagger JSON形式で照会します。

リクエスト

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

リクエストヘッダ

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

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

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

リクエスト例

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

curl -X GET 'https://apigateway.apigw.ntruss.com/api/v1/products/{product-id}/apis/{api-id}/stages/{stage-id}/canary/swagger-json' \
--header 'Content-Type: application/json' \
--header 'x-ncp-apigw-timestamp: {Timestamp}' \
--header 'x-ncp-iam-access-key: {Access Key}' \
--header 'x-ncp-apigw-signature-v2: {API Gateway Signature}'

レスポンス

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

レスポンス構文

構文は次の通りです。

{
"documentJson": "documentJson"
}

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

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

レスポンス例

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

{
"documentJson": "{"swagger" : "2.0",
  "info" : {
    "description" : "api Description<br/>https://**********.apigw.ntruss.com/api/v1",
    "version" : "2024-05-08T08:17:35Z",
    "title" : "api-***"
  },
  "host" : "**********.apigw.ntruss.com",
  "basePath" : "/***/***",
  "schemes" : [ "https" ],
  "paths" : {
    "/" : { },
    "/***" : {
      "post" : {
        "tags" : [ "v1" ],
        "parameters" : [ {
          "name" : "****",
          "in" : "query",
          "description" : "",
          "required" : false,
          "type" : "string",
          "x-ncp-parameter-is-logged" : false
        } ],
        "security" : [ {
          "x-ncp-iam" : [ ]
        } ],
        "responses" : {
          "200" : {
            "description" : "default"
          }
        },
        "x-ncp-apigw-use-body-when-formdata" : false,
        "x-ncp-apigateway-filters" : {
          "valid" : {
            "type" : "NONE"
          },
          "apiKey" : {
            "required" : true
          },
          "auth" : {
            "platform" : "IAM"
          }
        }
      }
    }
  },
  "securityDefinitions" : {
    "x-ncp-iam" : {
      "type" : "apiKey",
      "name" : "x-ncp-iam",
      "in" : "header",
      "x-ncp-apigw-auth-ver" : "v2"
    },
    "x-ncp-apigw-api-key" : {
      "type" : "apiKey",
      "name" : "x-ncp-apigw-api-key",
      "in" : "header"
    }
  }
}"
}