Swagger에서 데이터 가져오기

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

Swagger 파일을 불러와서 리소스를 생성합니다.

요청

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

요청 헤더

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

요청 경로 파라미터

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

요청 구문

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

{
  "apiName" : "apiName",
  "apiDescription" : "apiDescription",
  "importValidateType" : "importValidateType",
  "swagger" : "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"
    }
}