MENU
      Swagger로부터 Resource 가져오기

        Swagger로부터 Resource 가져오기


        기사 요약

        Classic/VPC 환경에서 이용 가능합니다.

        Swagger로부터 지정한 API로 Resource를 가져옵니다.

        요청

        요청 형식을 설명합니다. 요청 형식은 다음과 같습니다.

        메서드URI
        POST/products/{product-id}/apis/{api-id}/resources/import

        요청 헤더

        API Gateway에서 공통으로 사용하는 헤더에 대한 자세한 내용은 API Gateway 요청 헤더를 참조해 주십시오.

        요청 경로 파라미터

        파라미터에 대한 설명은 다음과 같습니다.

        필드타입필수 여부설명
        product-idStringRequiredAPI가 속한 Product ID
        api-idStringRequiredAPI ID

        요청 구문

        요청 구문은 다음과 같습니다.

        {
            "importValidateType" : "FAIL_ON_WARN",
            "swagger" : "swagger"
        }
        JSON

        요청 바디

        요청 바디에 대한 설명은 다음과 같습니다.

        필드타입필수 여부설명
        importValidateTypeStringOptional경고 발생 시 액션
        • FAIL_ON_WARN | IGNORE_WARN
          • FAIL_ON_WARN: 경고 실패
          • IGNORE_WARN: 경고 무시
        swaggerStringRequired가져오기할 Swagger의 전체 값

        요청 예시

        요청 예시는 다음과 같습니다.

        curl --location --request POST 'https://apigateway.apigw.ntruss.com/api/v1/products/***ksk9***/apis/***51hs***/resources/import' \
        --header 'x-ncp-apigw-timestamp: {Timestamp}' \
        --header 'x-ncp-iam-access-key: {Access Key}' \
        --header 'x-ncp-apigw-signature-v2: {API Gateway Signature}'\
        --header 'Content-Type: application/json' \
        --data '{
            "importValidateType": "IGNORE_WARN",
            "swagger": "{\n  \"openapi\" : \"3.0.1\",\n  \"info\" : {\n    \"title\" : \"3-0openapi\",\n    \"description\" : \"<br/>https://***038m***.apigw.ntruss.com/3-0openapi/v1\",\n    \"version\" : \"2024-04-25T10:08:52Z\"\n  },\n  \"servers\" : [ {\n    \"url\" : \"https://***038m***.apigw.ntruss.com/3-0openapi/v1\"\n  } ],\n (생략)  \"x-original-swagger-version\" : \"2.0\"\n}"
        }'
        Curl

        응답

        응답 형식을 설명합니다.

        응답 구문

        응답 구문은 다음과 같습니다.

        {
            "errorMessages" : [ "errorMessages" ],
            "warnMessages" : [ "warnMessages" ],
            "success" : true,
            "resourceList" : [ {
                "corsMaxAge" : "corsMaxAge",
                "resourceId" : "resourceId",
                "corsAllowMethods" : "corsAllowMethods",
                "methods" : [ {
                    "methodName" : "ANY",
                    "methodCode" : "methodCode"
                } ],
                "corsAllowOrigin" : "corsAllowOrigin",
                "resourcePath" : "resourcePath",
                "corsAllowCredentials" : "corsAllowCredentials",
                "corsExposeHeaders" : "corsExposeHeaders",
                "apiId" : "apiId",
                "corsAllowHeaders" : "corsAllowHeaders"
            } ]
        }
        JSON

        응답 상태 코드

        API Gateway에서 공통으로 사용하는 응답 상태 코드에 대한 자세한 내용은 API Gateway API 응답 상태 코드를 참조해 주십시오.

        응답 예시

        응답 예시는 다음과 같습니다.

        {
            "success": true,
            "warnMessages": [],
            "errorMessages": [],
            "resourceList": [
                {
                    "methods": [
                        {
                            "methodCode": "0001",
                            "methodName": "GET"
                        }
                    ],
                    "resourceId": "***i8xy***",
                    "resourcePath": "/{domainCode}"
                },
                {
                    "methods": [
                        {
                            "methodCode": "0006",
                            "methodName": "OPTIONS"
                        }
                    ],
                    "resourceId": "***3pbq***",
                    "resourcePath": "/ncp",
                    "corsAllowOrigin": "*",
                    "corsAllowMethods": "GET,POST,HEAD",
                    "corsAllowHeaders": "content-type,x-ncp-apigw-api-key,x-ncp-apigw-timestamp,x-ncp-iam-access-key,x-ncp-apigw-signature-v1,x-ncp-apigw-signature-v2",
                    "corsAllowCredentials": "",
                    "corsMaxAge": "",
                    "corsExposeHeaders": ""
                },
        // (생략)
            ]
        }
        JSON

        이 문서가 도움이 되었습니까?

        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.