restdocs

build 할 때 RestDocs 파일이 생성이 안되는 문제 트러블 슈팅 0. 들어가기 전에 저희 프로젝트는 RESTDocs를 파일을 만들어서 API를 문서화를 했습니다. 각각의 API를 종류에 맞게 adoc 파일로 관리를 해 유지보수를 하기 쉽게 사용하고 있었습니다. 하지만 이 방식의 단점은 한눈에 어떤 종류의 API가 있는지 파악하기가 어려웠습니다. 그래서 만들어진 adoc 파일을 하나의 파일로 만들 수 있는 gradle task를 만들어 사용했습니다(참고 PR). 하지만 이 과정에서 문제가 발생했는데, 이 글은 그 문제를 어떻게 해결했는지에 대해서 설명하는 글입니다. 1. 문제 상황 먼저 intellij에서 spring boot를 실행시키면 gradle에 작성한 task 대로 정상 작동합니다. ta..

[Spring] Spring Rest docs 적용해보기 0. 들어가기 전에 API문서를 Postman으로 만들었었는데, 설정이 바뀔 때마다 업데이트하기가 힘들다는 단점을 느껴서 Restdocs에 대해서 알아봤습니다. 1. Spring REST docs란? REST API의 명세에 대한 문서화 툴 API 문서화의 대표적 주자는 Swagger와 REST docs가 있습니다. 그 중에서 제가 REST docs를 더 선호하는데 이유는 다음과 같습니다. Swagger와 달리 Restdocs는 테스트 코드를 통해 작동하기 떄문에 테스트 코드를 필수적으로 작성해야 합니다. Swagger는 운영코드인 Controller 단에서 @Api나 @ApiImplicitParams와 같은 어노테이션을 통해 문서화를 해서 운영 ..