Classic/VPC環境で利用できます。
指定した Productに公開された API文書の中から特定の API文書を照会します。リクエスト
リクエスト形式を説明します。リクエスト形式は次の通りです。
| メソッド | URI |
|---|---|
| GET | /published-products/{product-id}/apis/{api-id}/documents |
リクエストヘッダ
API Gatewayで共通して使用されるヘッダの詳細は、API Gatewayのリクエストヘッダをご参照ください。
リクエストパスパラメータ
パラメータの説明は次の通りです。
| フィールド | タイプ | 必須の有無 | 説明 |
|---|---|---|---|
product-id |
String | Required | APIが属する Product ID
|
api-id |
String | Required | 文書を照会する対象の API ID
|
リクエスト例
リクエストのサンプルコードは次の通りです。
curl --location --request GET 'https://apigateway.apigw.ntruss.com/api/v1/published-products/***ksk9***/apis/***51hs***/documents' \
--header 'x-ncp-apigw-timestamp: {Timestamp}' \
--header 'x-ncp-iam-access-key: {Access Key}' \
--header 'x-ncp-apigw-signature-v2: {API Gateway Signature}'
レスポンス
レスポンス形式を説明します。
レスポンス構文
レスポンス構文は次の通りです。
{
"apiId" : "apiId",
"documentMd" : "documentMd",
"tenantId" : "tenantId",
"modifier" : "modifier"
}
レスポンスステータスコード
API Gatewayで共通して使用されるレスポンスステータスコードの詳細は、API Gatewayのレスポンスステータスコードをご参照ください。
レスポンス例
レスポンスのサンプルコードは次の通りです。
{
"apiId": "***51hs***",
"documentMd": "",
"tenantId": "***e230cebc1402ba89b148896951***",
"modifier": "***d3020-5bb7-11ec-bfb8-246e96591***"
}