우아한테크코스 4기
RestDocs 시작하기
API 문서 자동화를 위한 RestDocs 적용 방법에 대해 알아봅시다! API 문서 자동화는 정말 중요한 일입니다. 사람이 손으로 해서는 결국 한계가 있고, 규모가 커질수록 걷잡을 수 없게 됩니다. 가령 문서 파일로 API를 관리하고, 이를 공유하고 업데이트 하는 식으로 사용하게 될 경우, 형상관리를 하더라도 분명 이슈가 발생하게 됩니다. 코드에 반영을 했는데 문서에 반영을 하지 않는다던가, 최신화되지 않은 문서를 참조하고 있다거나, 변형된 파일이 공유된다거나.. 정말 많은 이슈가 생길 수 있습니다. 그래서, 프로덕트가 배포되는 시점에 문서도 자동화되어 배포될 수 있게 구성할 수 있다면, 그리고 프로덕션 코드에는 영향이 없다면, 정말 좋겠습니다. 초기 설정이 다소 까다로워서 그렇지 한 번 구축을 완료하..