핵심 요약
트렌비가 마이크로서비스 환경에서 API 문서를 OpenAPI로 통합 관리하는 공용 API 문서 서버를 구축하고, Swagger UI로 시각화하며 CI/CD(GitHub Actions)로 개발 환경에서 자동 업데이트된 문서를 AWS S3에 업로드하는 파이프라인을 구성했습니다.
구현 방법
- OpenAPI 형식으로 문서 통일 및 관리 체계 구축
- Spring Rest Docs를 OpenAPI로 마이그레이션하기 위해 restdocs-api-spec 도구 활용
- Swagger UI를 활용한 다중 OpenAPI 문서의 시각화 및 조회
- Gradle 명령(예: ./gradlew openapi3 --no-build-cache)으로 OpenAPI 문서 생성
- GitHub Actions 기반 CI/CD로 서비스 배포 시 API 문서 생성 및 S3 업로드 자동화
- 개발 환경에 한해 API 문서 서버 운영으로 운영 데이터의 안전성 확보
주요 결과
- 중앙 집중형 API 문서 관리와 도메인 간 원활한 협업 가능
- 문서 생성과 배포가 자동화되어 최신 상태 유지 용이
- 운영 환경 데이터를 보호하기 위해 개발 환경에서만 문서 서버를 운영
