Swaggerからデータインポート
- 印刷する
- PDF
Swaggerからデータインポート
- 印刷する
- PDF
記事の要約
この要約は役に立ちましたか?
ご意見ありがとうございます
Classic/VPC環境で利用できます。
Swaggerファイルをインポートしてリソースを作成します。
リクエスト
リクエスト形式を説明します。リクエスト形式は次の通りです。
メソッド | URI |
---|---|
POST | /products/{product-id}/apis/import |
リクエストヘッダ
API Gatewayで共通して使用されるヘッダの詳細は、API Gatewayのリクエストヘッダをご参照ください。
リクエストパスパラメータ
パラメータの説明は次の通りです。
フィールド | タイプ | 必須の有無 | 説明 |
---|---|---|---|
product-id | String | Required | APIと関連付けられた Product ID |
リクエスト構文
リクエスト構文は次の通りです。
{
"apiName" : "apiName",
"apiDescription" : "apiDescription",
"importValidateType" : "importValidateType",
"swagger" : "swagger"
}
リクエストボディ
リクエストボディの説明は次の通りです。
フィールド | タイプ | 必須の有無 | 説明 |
---|---|---|---|
apiName | String | Required | APIデプロイの説明
|
apiDescription | String | Optional | デプロイ対象の APIに作成された Stage ID
|
importValidateType | String | Required | Swaggerファイルをインポートする際にエラーまたは警告が発生した場合、インポートを停止するか、無視してインポートするかを決める
|
swagger | String | Required | インポートする swaggerのすべての値 |
リクエスト例
リクエストのサンプルコードは次の通りです。
curl -X POST 'https://apigateway.apigw.ntruss.com/api/v1/products/{product-id}/apis/import' \
--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}'
-data '{
"apiName": "api-***",
"apiDescription": "api-*** Description",
"importValidateType": "FAIL_ON_WARN",
"swagger": "{\n \"openapi\" : \"3.0.1\",\n ~~~ "x-original-swagger-version\" : \"2.0\"\n}"
}'
レスポンス
レスポンス形式を説明します。
レスポンス構文
構文は次の通りです。
{
"success": true,
"warnMessages": [warnMessages],
"errorMessages": [errorMessages],
"api": {
"productId": "productId",
"apiId": "apiId",
"apiName": "apiName",
"apiDescription": "apiDescription",
"tenantId": "tenantId",
"modifier": "modifier",
"modTime": "2024-05-13T04:13:56Z",
"isDeleted": false,
"domainCode": "domainCode"
}
}
レスポンスステータスコード
API Gatewayで共通して使用されるレスポンスステータスコードの詳細は、API Gatewayのレスポンスステータスコードをご参照ください。
レスポンス例
レスポンスのサンプルコードは次の通りです。
{
"success": true,
"warnMessages": [],
"errorMessages": [],
"api": {
"productId": "*****n0bk",
"apiId": "*****ie0xz",
"apiName": "api-***",
"apiDescription": "api-*** Description",
"tenantId": "*****02f55ae4436913a6e2c65bab47c",
"modifier": "d12c9fd0-****-****-****-246e96591a38",
"modTime": "2024-05-13T04:13:56Z",
"isDeleted": false,
"domainCode": "PUB"
}
}
この記事は役に立ちましたか?