documentation

· TIL
✍ 이 글은 제가 오늘 공부하거나 코딩하며 배우거나 느꼈던 것들을 적는 글이므로, 해라체를 사용하는 것을 이해해주시면 감사하겠습니다. Spring Rest Docs Spring에서 API 문서를 만드는 데 제일 유명한 라이브러리는 Swagger가 아닐까 싶다. 하지만, 프로덕션 코드에 주석으로 덕지덕지 붙여줘야 한다는 단점이 있었다. 이것을 해결하기 위해 Spring Rest Docs가 나왔다! (이하 SRD) SRD의 장점은 세가지가 있다. 테스트 코드를 작성하면서 API 문서를 작성할 수 있다! 프로덕션 코드에 API 문서 관련 코드가 없다! 자유롭게 고칠 수 있다! 라는 장점이 있어서, SRD를 한 번 써보기로 했고, 개인 프로젝트에서 마침 열심히 테스트 코드를 많이 작성하고 있어서 적용을 해보았다..
라페dev
'documentation' 태그의 글 목록