公開された Stage文書の照会

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

リクエスト

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

リクエストヘッダ

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

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

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

リクエスト例

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

curl --location --request GET 'https://apigateway.apigw.ntruss.com/api/v1/products/***ksk9***/apis/***51hs***/stages/***5ei7***/swagger-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": "{\n  \"swagger\" : \"2.0\",\n  \"info\" : {\n    \"description\" : \"<br/>https://***ksk9***.apigw.ntruss.com/api000/stage\",\n    \"version\" : \"2024-05-08T02:32:42Z\",\n    \"title\" : \"api000\"\n  },\n  \"host\" : \"***ksk9***.apigw.ntruss.com\",\n  \"basePath\" : \"/api000/stage\",\n  \"schemes\" : [ \"https\" ],\n  \"paths\" : {\n    \"/\" : {\n      \"get\" : {\n        \"tags\" : [ \"stage\" ],\n        \"description\" : \"\",\n        \"parameters\" : [ ],\n        \"responses\" : {\n          \"200\" : {\n            \"description\" : \"default\"\n          }\n        (省略) }\n  }\n}"
}