프로젝트 진행 시 진행 중인 업무 관련 내용들의 문서화 작업이 꼭 필요하다.(필요성은 말 안 해도 다 아신다고 생각한다.) 그중 API 서버를 개발하였으면 해당 API의 매뉴얼 및 Spec 등 문서화하는 과정이 필요하다. 하지만 문서작업은 기능이 추가되거나, 수정될 때마다 문서 작성하는 시간이 많이 소요되고 귀찮아서 잘 안 하게 된다. 그래서 자동화 툴을 찾게 되는데 Swagger라는 좋은 툴이 있다. 그중 API Spec 문서를 자동화하는 해주는 Swagger에 대해서 알아보자! Swaager 설정 (개발 환경은 Spring Boot + Gradle 환경에서 세팅하였다) 여러 블로그랑 공식문서를 보면서 적용 테스트를 다양하게 해 봤는데 제일 빠른 방법을 알려주겠다. 1. Build.gradle 설정 아..

RestAPI 개발 시 참고하면 좋은 자료들을 공유하려고한다. 참고자료 https://youtu.be/RP_f5dMoHFc https://shoark7.github.io/programming/knowledge/what-is-rest https://sharplee7.tistory.com/49 https://meetup.toast.com/posts/92 https://devlog-wjdrbs96.tistory.com/197?category=882974 (응답에 대한 예제가 있어서 적용하기 좋은 글이다.) http://blog.storyg.co/rest-api-response-body-best-pratics