핵심 요약
매드업이 Swagger와 OpenAPI Generator를 도입해 프런트엔드에서 API 인터페이스를 타입으로 자동 생성하는 방법을 소개합니다.
주요 특징
- Swagger(OpenAPI) 표준에 따라 API 설계 및 문서 자동 생성
- OpenAPI Generator로 openapi.json 기반의 모델과 axios 기반 API 호출 함수 자동 생성
- 자동 생성된 모델은 /models 폴더에 생성되며 필요한 부분은 /src/model로 참조하도록 구성
- 다국어 문서 생성 기능 포함 및 타입스크립트 타입과 API 클라이언트 코드 제공
적용 고려사항
- openapi.json 위치에 따라 -i 옵션 구성 필요
- 생성 파일은 /models 폴더에 자동 생성되므로 보통 Git ignore에 추가하는 것이 일반적
- 생성된 타입을 프로젝트에 맞게 필요한 부분만 참조하여 사용하는 방식이 일반적
