Spring Rest Docs 사용하기 (1) - 기본 설정과 API 문서 생성

그동안 API 문서화를 위해 Swagger UI를 사용했다. 하지만 사용하면서 몇 가지 아쉬운 점들이 있었다. 문서의 최신화가 어려웠다. 코드가 변경될 때마다 어노테이션을 함께 수정해야 했는데, 이 과정에서 종종 누락이 발생했고 실제 API와 문서 간의 불일치가 생겼다.둘째, 비즈니스 로직과 무관한 문서화 코드가 Controller에 계속 쌓이는 것이 불편했다. @ApiOperation, @ApiParam 등의 어노테이션들이 Controller 클래스를 복잡하게 만들고, 코드의 가독성을 떨어뜨렸다. 최근 테스트 코드 작성에 집중하면서 Controller Slice 테스트를 통해 API 문서를 자동 생성할 수 있는 Spring Rest Docs를 알게 되었다. 테스트가 성공해야만 문서가 생성되는 구조라 문..