API 문서 자동화 적용 (Spring REST Docs & Swagger UI) feat. OAS 기반 API 문서화
프론트에 넘길 API 문서를 만들면서 테스트를 강제하는 Spring REST Docs와 UI가 좋은 Swagger UI를 굳이 둘 다 붙인 구성을 정리했다. OAS로 두 문서를 하나로 합치는 방안은 설계만 그려두고 후속 과제로 남겼다.
작성날짜: 24.08.28
상황
- API 문서 프론트엔드 팀 전달 필요
- API 문서 자동화
- 테스트 강제화 > Spring REST Docs
- UI > Swagger UI
- 2개의 장점 활용하고 싶음
시도
- Swagger UI + Spring REST Docs 2개 개발 문서 작업 진행
현재 문서 자동화 요약
문서 접속 방법 요약
추후 개발 여유가 되면 문서 2개 통합 시도 예정 (아래 내용 참고)
- 오픈소스
Spring REST Docs API Specification Integration활용한 OAS 기반 API 문서화 자동 가능 - 아쉬운 점. 오픈소스이기에 커스텀 어렵고 이슈 발생 대응 어려움
OAS 기반 API 문서 자동화 프로세스 기본 설계
OAS 기반 API 문서 자동화 프로세스 이너서클 커머스 관리자 프로젝트 적용 설계
