# MSA 환경의 수많은 API 문서 자동으로 통합하기

> Clean Markdown view of GeekNews topic #14560. Use the original source for factual precision when an external source URL is present.

## Metadata

- GeekNews HTML: [https://news.hada.io/topic?id=14560](https://news.hada.io/topic?id=14560)
- GeekNews Markdown: [https://news.hada.io/topic/14560.md](https://news.hada.io/topic/14560.md)
- Type: news
- Author: [yechoi](https://news.hada.io/@yechoi)
- Published: 2024-04-29T15:00:17+09:00
- Updated: 2024-04-29T15:00:17+09:00
- Original source: [techblog.lycorp.co.jp](https://techblog.lycorp.co.jp/ko/api-document-integration-and-documentation-automation?fbclid=IwZXh0bgNhZW0CMTEAAR0nLx9TFzkSXTPOfnps8GvLRxdYX8jwrf9Vqx0R0HrwhFiiVRTlMjIbHUw_aem_Aaep4HI4dEWDyB-j_hUVrKD3vxoZjVMio-fzb3S_bam56zaoQX45HwwJFpvLyCz7T8sIrZjXaxIDqf163EZP8RIa)
- Points: 12
- Comments: 1

## Topic Body

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

## Comments



### Comment 24792

- Author: elijah17
- Created: 2024-04-30T09:28:08+09:00
- Points: 1

이와 비슷한 문제를 해결하기 위해   
Swagger API doc을 수집하고 이를 다시 Swagger ui로 보여주는 웹어플리케이션을 만들어 오픈소스로 공개하고 있습니다.   
https://github.com/stray-cat-developers/giant-otter  
혹시나 비슷한 고민을 하시는 분들은 사용을 해보시는 것도 좋을 듯 하네요