-
Notifications
You must be signed in to change notification settings - Fork 0
백엔드 API 명세서 도구
강웅빈 edited this page Jan 2, 2024
·
3 revisions
자동으로 API 명세서를 작성하기 위해 RestDocs
를 사용하기로 결정했습니다.
Swagger가 아닌 RestDocs를 사용하기로한 이유는 프로덕션 코드에 문서화에 대한 코드가 없어 가독성
이 증가한다는 점과 테스트 코드의 강제성
때문입니다.
올바른 테스트 코드를 작성하지 않으면 API가 문서화 되지 않기 때문에 의미있는 테스트 코드
를 작성할 수 있습니다.
또 API의 스펙이 변화해도 직접 수정할 필요 없이 자동으로 변경된 API 스펙으로 문서화 되기 때문에 RestDocs를 사용하기로 했습니다.