백엔드
Ktor프레임웍 #2 : OpenAPI 활용
두줄요약
Ktor REST API 서버에서 OAS 스펙을 작성하고 OpenAPI Generator로 모델 코드를 생성하는 방법을 설명했습니다. 생성된 모델을 Ktor 라우트에 연결하고 OpenAPI UI로 스펙을 서빙하는 구성도 함께 다뤘습니다.
핵심 내용
- Ktor REST API 서버에서 OpenAPI Specification(OAS)로 API와 데이터 모델 명세를 작성하는 흐름
- OpenAPI Generator로 Kotlin 서버용 모델 코드를 생성하고, Ktor 라우트에서 해당 모델을 활용하는 방식
- Gradle 플러그인, 코드 생성 경로, ignore 규칙, OpenAPI UI 서빙 설정까지 포함한 프로젝트 구성
적용해볼 점
- 스펙 파일과 생성 코드 분리를 통해 명세 기반 개발 구조 마련
- 모델 코드만 생성하고 라우트는 직접 작성하는 방식으로 현재 Ktor 생성기 한계 보완
- openapi 플러그인과 swagger 파일 경로 설정으로 API 문서 화면 제공