API 문서 통합 및 자동화

이 게시물은 MSA 환경에서 여러 서비스의 REST API 문서를 효율적으로 관리하고 자동화하는 방법을 소개합니다.

문제점과 요구 사항

• 서비스별로 분산된 API 문서 관리의 어려움과 수동 업데이트의 부담
• 문서 통합, 그룹화, 빠른 반영 및 배포 자동화 필요

해결 방안 및 도구

• Springdoc 라이브러리로 OpenAPI 기반 문서 자동 생성
• Redocly CLI로 JSON 문서 통합 및 HTML 변환
• GitHub Actions로 문서 생성부터 배포까지 자동화
• GitHub Pages를 통한 웹 호스팅

확장성 및 운영

• 여러 리포지터리 문서의 통합과 워크플로 호출 구조
• 개발 초기 API 스펙 공유를 위한 빠른 문서 배포

이 방법은 개발과 타 부서 간의 명확한 커뮤니케이션과 업무 효율성 증대에 기여하며 지속적으로 활용 중입니다.