MSA 환경의 수많은 API 문서 자동으로 통합하기
(techblog.lycorp.co.jp)- MSA 환경에서는 서비스 도메인만큼 API 명세가 생기는 문제 발생
- 이러한 문제를 해결하기 위해,
- MSA 환경에서 다양한 서비스 문서를 하나의 URL에서 보여주고.
- API 문서 페이지를 자동으로 생성하는 방법을 고민
- 요구사항 정의와 아키텍쳐
- API 문서 통합에 사용한 도구와 스팩
- API 문서 통합 구현
- OpenAPI 스펙을 충족하기 위한 기본 코드 작업
- API 문서를 JSON 형태로 추출
- GitHub Pages로 웹 호스팅
- GitHub Actions를 이용해 자동화
- 다중 레포 환경에서 API 문서 통합 적용하는 법