OpenAPI / Swagger 가져오기
API 스펙을 가져와 엔드포인트와 데이터 구조를 자동 생성하기
3 min read
API 를 하나하나 손으로 설정할 필요 없이, 기존 API 스펙을 가져오면 엔드포인트와 데이터 구조를 자동으로 만들어 줍니다. 프로토타입을 진짜 데이터로 채우는 가장 빠른 방법입니다.
가져올 수 있는 스펙
- OpenAPI 3.x (JSON 또는 YAML)
- Swagger 2.0 (OpenAPI 2.0)
파일에서 가져오거나, 스펙이 공개된 URL 에서 바로 가져올 수 있습니다. Swagger 2.0 은 자동으로 인식되어 처리되므로 따로 신경 쓸 필요가 없습니다.
가져오는 방법
API 추가 메뉴, API 목록, API 에디터, 툴바 어디서나 Import OpenAPI… 를 선택하고 파일이나 URL 을 지정합니다.
자동으로 만들어지는 것
- API Collection — 스펙 단위의 그룹. 이름·설명·서버(base URL)가 함께 들어옵니다.
- API 엔드포인트 — 각 경로(operation)가 하나의 API 로. 메서드·경로·파라미터·요청 본문이 설정됩니다.
- Data Schema —
components.schemas가 데이터 구조로. 응답 데이터를 화면에 바인딩할 수 있게 됩니다. - Data Enum — 스펙에 정의된 열거형 값들.
- 응답 스키마 — 상태 코드별 응답 구조.
다음 단계
가져온 API 의 응답을 화면에 연결하는 방법은 API 응답을 화면에 바인딩하기 에서 다룹니다.
공개 API 의 OpenAPI 문서 URL 하나만 있으면 몇 초 만에 실제 데이터를 다루는 화면을 만들기 시작할 수 있습니다. 날씨, 환율, 뉴스 등 공개 API 로 먼저 연습해 보세요.