SDKのエクスポート
- 印刷する
- PDF
SDKのエクスポート
- 印刷する
- PDF
記事の要約
この要約は役に立ちましたか?
ご意見ありがとうございます
Classic/VPC環境で利用できます。
Canaryにデプロイされた APIを Swagger JSON 2.0、Open API JSON 3.0、Java SDK形式でエクスポートします。
リクエスト
リクエスト形式を説明します。リクエスト形式は次の通りです。
| メソッド | URI |
|---|---|
| GET | /products/{product-id}/apis/{api-id}/stages/{stage-id}/canary/export |
リクエストヘッダ
API Gatewayで共通して使用されるヘッダの詳細は、API Gatewayのリクエストヘッダをご参照ください。
リクエストパスパラメータ
パラメータの説明は次の通りです。
| フィールド | タイプ | 必須の有無 | 説明 |
|---|---|---|---|
product-id | String | Required | APIと関連付けられた Product ID
|
api-id | String | Required | Productに作成された API ID
|
stage-id | String | Required | APIに作成された Stage ID
|
リクエストクエリパラメータ
パラメータの説明は次の通りです。
| フィールド | タイプ | 必須の有無 | 説明 |
|---|---|---|---|
platform | String | Optional | ダウンロードする Platformファイル形式
|
packageName | String | Optional | エクスポート対象の Package名 |
groupId | String | Optional | JAVA SDK形式でエクスポートする場合、Javaの Group IDを指定 |
artifactId | String | Optional | JAVA SDK形式でエクスポートする場合、Javaの Artifact IDを指定 |
artifactVersion | String | Optional | JAVA SDK形式でエクスポートする場合、Javaの Artifact Versionを指定 |
license | String | Optional | JAVA SDK形式でエクスポートする場合、Javaの Licenseを指定 |
version | String | Optional | JAVA SDK形式でエクスポートする場合、Javaの Versionを指定 |
リクエスト例
リクエストのサンプルコードは次の通りです。
curl -X GET 'https://apigateway.apigw.ntruss.com/api/v1/products/{product-id}/apis/{api-id}/stages/{stage-id}/canary/export' \
--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}'
レスポンス
レスポンス形式を説明します。
レスポンス構文
レスポンス構文は次の通りです。
"Download File"
レスポンスステータスコード
API Gatewayで共通して使用されるレスポンスステータスコードの詳細は、API Gatewayのレスポンスステータスコードをご参照ください。
この記事は役に立ちましたか?