내가 만든 API를 널리 알리기 - Spring REST Docs 가이드편

컬리 신규 입사자가 '선물하기' 서비스 재개발 프로젝트에 참여하며 겪은 경험을 공유하는 글입니다. 기존 Wiki 기반의 API 문서화 방식의 불편함을 해소하기 위해 Spring REST Docs를 도입하여 테스트 기반으로 Asciidoc 스니펫을 생성하고 이를 조합해 문서를 만드는 과정을 소개합니다.

Swagger와 비교하며 Spring REST Docs를 선택한 이유를 설명하고, 실제 프로젝트에 적용한 경험을 바탕으로 API 문서화의 중요성과 효과를 강조합니다. 예제 프로젝트를 통해 Spring REST Docs 사용법을 안내하며, API를 널리 알리는 데 기여하는 문서화의 가치를 이야기합니다.