API 문서
[Spring] Spring REST Docs 도입기
[Spring] Spring REST Docs 도입기
2023.05.10Spring REST Docs 도입프로젝트를 수행하던 중, 개발 중에 기획이 여러 번 바뀌고 이에 따라 오고 가는 자원의 형태도 달라져 API 문서를 수정하는 일이 자주 생겼다. 하지만 잘못하여 실수로 적는 일도 생기고, 매번 API가 변경될 때마다 문서까지 수정하여 전달하기엔 시간 소모가 많았다. 때문에 Spring REST Docs를 통해 컨트롤러 테스트와 동시에 문서 작성을 자동화시켜 바로 전달할 수 있는 환경을 갖출 수 있어 도입하게 되었다. 현재 Spring REST Docs는 Java 17이상, Spring Framework 6 이상의 환경을 요구한다. build 구성Spring REST Docs를 사용하기 위해 다음과 같이 빌드를 작성한다. (Gradle 환경)plugins { id "or..