Swaggerからデータインポート
    • PDF

    Swaggerからデータインポート

    • PDF

    記事の要約

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

    Swaggerファイルをインポートしてリソースを作成します。

    リクエスト

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

    メソッドURI
    POST/products/{product-id}/apis/import

    リクエストヘッダ

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

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

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

    フィールドタイプ必須の有無説明
    product-idStringRequiredAPIと関連付けられた Product ID

    リクエスト構文

    リクエスト構文は次の通りです。

    {
      "apiName" : "apiName",
      "apiDescription" : "apiDescription",
      "importValidateType" : "importValidateType",
      "swagger" : "swagger"
    }
    

    リクエストボディ

    リクエストボディの説明は次の通りです。

    フィールドタイプ必須の有無説明
    apiNameStringRequiredAPIデプロイの説明
    • 1~20文字
    apiDescriptionStringOptionalデプロイ対象の APIに作成された Stage ID
    • 0~300文字
    importValidateTypeStringRequiredSwaggerファイルをインポートする際にエラーまたは警告が発生した場合、インポートを停止するか、無視してインポートするかを決める
    • FAIL_ON_WARN | IGNORE_WARN
      • FAIL_ON_WARN: 警告失敗
      • IGNORE_WARN: 警告無視
    swaggerStringRequiredインポートする 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"
        }
    }
    

    この記事は役に立ちましたか?

    What's Next
    Changing your password will log you out immediately. Use the new password to log back in.
    First name must have atleast 2 characters. Numbers and special characters are not allowed.
    Last name must have atleast 1 characters. Numbers and special characters are not allowed.
    Enter a valid email
    Enter a valid password
    Your profile has been successfully updated.