목록restdocs (1)

끄적끄적

Spring Rest Docs 사용하기

서론 백앤드를 하다보면 가장 중요한 작업 중 하나가 API 문서 작성이다. 필자의 경우 다른 플랫폼에서는 대부분 Swagger 를 이용해 왔는데 Spring 에서는 테스트코드를 바탕으로 api docs 를 만들어 주는 프레임워크이다. 특히나 테스트 코드를 강제할 수 있다는 부분에서 매력적으로 다가왔다. 그래서 이번에 간단한 사용법에 대해서 적어볼까 한다. 시작하기 우선 이전 포스팅에서 구성한 멀티모듈 프로젝트를 바탕으로 만들어볼까 한다. 우리의 멀티모듈 프로젝트에서 restdocs 를 사용할 부분은 api 모듈 부분이다. 이 모듈의 build.gradle 에 rest docs 에 필요한 설정들을 정의해준다. 또한 포스팅에서는 WebTesetClient 를 사용해서 작성할 예정이므로 이에대한 부분또한 추가..
개발/java & spring 2022. 11. 1. 18:30
이전 Prev 1 Next 다음