---
title: "Swagger에서 데이터 가져오기"
slug: "apigateway-api-import"
tags: ["API Gateway", "API"]
updated: 2026-04-23T08:55:53Z
published: 2026-04-23T09:02:24Z
---

> ## Documentation Index
> Fetch the complete documentation index at: https://api.ncloud-docs.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Swagger에서 데이터 가져오기

<p class="platform-info type-classic-vpc">Classic/VPC 환경에서 이용 가능합니다.</p>

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

## 요청<a name="요청"></a>
요청 형식을 설명합니다. 요청 형식은 다음과 같습니다.
| 메서드 | URI |
| :--- | :--- |
| POST | /api/v1/products/{product-id}/apis/import |

### 요청 헤더<a name="요청헤더"></a>
API Gateway에서 공통으로 사용하는 헤더에 대한 정보는 [API Gateway 요청 헤더](/docs/ai-application-service-apigateway#요청헤더)를 참조해 주십시오.

### 요청 경로 파라미터 <a name="요청경로파라미터"></a>
요청 경로 파라미터에 대한 설명은 다음과 같습니다.
| 필드 | 타입 | 필수 여부 | 설명 |
| :--- | :--- | :--- | :--- |
| `product-id` | String | Required | API에 연결된 Product ID |

### 요청 구문<a name="요청구문"></a>
요청 구문은 다음과 같습니다. 

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

### 요청 바디<a name="요청바디"></a>
요청 바디에 대한 설명은 다음과 같습니다.

| 필드 | 타입 | 필수 여부 | 설명 |
| :--- | :--- | :--- | :--- | 
| `apiName` | String| Required | API 배포에 대한 설명<ul><li>1~20자</li></ul> |
| `apiDescription` | String| Optional | 배포할 API에 생성된 Stage ID<ul><li>0~300자</li></ul> |
| `importValidateType` | String| Required | Swagger 파일을 가져올 때 오류 또는 경고가 발생하면 가져오기를 중단할지, 무시하고 가져올지를 결정<ul><li>`FAIL_ON_WARN` \| `IGNORE_WARN`<ul><li>`FAIL_ON_WARN`: 경고 실패</li><li>`IGNORE_WARN`: 경고 무시</li></ul></li></ul> |
| `swagger` | String| Required | 가져올 swagger의 전체 값 |

### 요청 예시<a name="요청예시"></a>
요청 예시는 다음과 같습니다.
```shell
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}"
}'
```    

## 응답<a name="응답"></a>
응답 형식을 설명합니다.

### 응답 구문<a name="응답구문"></a>
응답 구문은 다음과 같습니다.
```json
{
    "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"
    }
}
```

### 응답 상태 코드 <a name="응답상태코드"></a>
API Gateway에서 공통으로 사용하는 응답 상태 코드에 대한 정보는 [API Gateway 응답 상태 코드](/docs/ai-application-service-apigateway#응답상태코드)를 참조해 주십시오.

### 응답 예시<a name="응답예시"></a>
응답 예시는 다음과 같습니다. 

```json
{
    "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"
    }
}
```