마이크로 서비스 환경에서 통합된 API 문서 서버 구축하기

트렌비는 마이크로서비스 환경에서 API 문서 관리의 비효율성을 해결하기 위해 통합된 공용 API 문서 서버를 구축했습니다. 기존에는 서비스마다 Swagger, Spring Rest Docs, Notion 등 다양한 방식으로 API 명세를 관리하여 혼란과 비효율이 발생했습니다.

NHN의 사례를 참고하여 Swagger와 Spring Rest Docs로 생성된 API 문서를 OpenAPI 형식으로 통일하고, 이를 한 곳에서 관리하는 공용 서버를 구축했습니다. Spring Rest Docs의 경우, restdocs-api-spec 오픈소스를 활용하여 OpenAPI 문서를 쉽게 생성하고 마이그레이션할 수 있었습니다.

이로써 API 문서 공유 및 관리가 효율화되었습니다.