마이크로 서비스 환경에서 API 문서 서버 구축

이 게시물은 마이크로 서비스 환경에서 효율적으로 API 문서를 관리할 수 있는 통합된 API 문서 서버 구축에 대해 설명합니다.

API 문서 형식 통일하기

• Swagger와 Spring RestDocs 문서 형식을 OpenAPI 형식으로 통합
• 기존 Spring RestDocs를 OpenAPI 문서로 쉽게 마이그레이션

자동 관리 및 CI/CD 구성

트렌비는 API 문서의 자동 업데이트를 위해 GitHub Action을 활용하여 AWS S3에 API 문서를 자동으로 배포하는 CI/CD 파이프라인을 구성하였습니다.