MENU
      Import data from Swagger

        Import data from Swagger


        Article summary

        Available in Classic and VPC

        Create a resource by importing a Swagger file.

        Request

        The following describes the request format for the endpoint. The request format is as follows:

        MethodURI
        POST/products/{product-id}/apis/import

        Request headers

        For headers common to API Gateway, see API Gateway common request headers.

        Request path parameters

        The following describes the parameters.

        FieldTypeRequiredDescription
        product-idStringRequiredProduct ID associated with the API

        Request syntax

        The request syntax is as follows.

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

        Request body

        The following describes the request body.

        FieldTypeRequiredDescription
        apiNameStringRequiredDescription for the API deployment
        • 1 - 20 characters
        apiDescriptionStringOptionalStage ID created on the API to deploy
        • 0 - 300 characters
        importValidateTypeStringRequiredDetermine whether to abort the import or ignore it and import if an error or warning occurs when importing a Swagger file
        • FAIL_ON_WARN | IGNORE_WARN
          • FAIL_ON_WARN: Fail on warning
          • IGNORE_WARN: Ignore warning
        swaggerStringRequiredFull value of Swagger to import

        Request example

        The following is a sample request.

        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}"
        }'
        Curl

        Response

        The following describes the response format.

        Response syntax

        The syntax is as follows.

        {
            "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"
            }
        }
        JSON

        Response status codes

        For response status codes common to API Gateway, see API Gateway response status codes.

        Response example

        The following is a sample response.

        {
            "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"
            }
        }
        JSON

        Was this article helpful?

        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.