[Spring Rest Docs ] Spring Rest Docs 적용할 때 발생한 문제 및 해결 방법

MockMvc 에서 한글 깨짐 현상으로 인해, MockMvcBuilder를 사용하여, MockMvc 객체를 생성했을 때, 아래와 같은 에러가 발생했다면,

에러

REST Docs configuration not found. Did you forget to apply a MockMvcRestDocumentationConfigurer when building the MockMvc instance?

해결방법

기존에 테스트 클래스 상단에 @AutoConfigureRestDocs 으로 자동설정을 했었다면,

해당 자동설정은 삭제하고,

아래 이미지처럼 @ExtendWith(RestDocumentationExtension.class) 설정과 MockMvcBuilders 에서 apply를 이용해 documentationConfiguration(restDocumentationContextProvider)를 추가한다.

 

 

 

 

MockMvc.perform에서 get요청을 했을 경우, 아래와 같은 에러가 발생했다면,

에러 발생

urlTemplate not found. If you are using MockMvc did you use RestDocumentationRequestBuilders to build the request?

해결방법

사용하던 메서드가 클래스가 MockMvcRequestBuilders 에 있는 get 메서드를 사용했다면,

import static org.springframework.test.web.servlet.request.MockMvcRequestBuilders.get;

아래와 같이 클래스 RestDocumentationRequestBuilders 가 제공하는 get 메서드를 사용하면 된다.

import static org.springframework.restdocs.mockmvc.RestDocumentationRequestBuilders.get;

 

 

 

 

※ 참고

requestFields, responseFields를 사용하고 싶은데 메서드가 안나올 때,

해결방법

아래 패키지 import 하고,

import static org.springframework.restdocs.mockmvc.MockMvcRestDocumentation.documentationConfiguration;

다음과 같이 사용한다.