Spring Rest Docs: pathParameters 사용법 urlTemplate not found. If you are using MockMvc did you use RestDocumentationRequestBuilders to build the request?

https://docs.spring.io/spring-restdocs/docs/3.0.0-SNAPSHOT/reference/htmlsingle/#documenting-your-api-query-parameters

Spring REST Docs

이 글을 읽으면 더 자세하게 알 수 있다.

발생한 에러

해결방법

이유

Spring REST Docs는 MockMvc를 사용하여 API 요청을 모방하고 테스트하는데, MockMvc는 Spring MVC 프레임워크의 일부다.

그러나 RestDocumentationRequestBuilders는 MockMvcRequestBuilders를 확장한 클래스로, REST Docs의 문서화 기능을 추가로 제공한다.

 

RestDocumentationRequestBuilders는 MockMvcRequestBuilders와 함께 사용되어 API의 경로 변수(path parameters)를 문서화하는 데 특화되어 있다.

경로 변수는 URL 경로의 일부로 전달되는 동적인 값으로, 예를 들면 "/users/{id}"와 같은 형태로 사용된다. 경로 변수는 테스트 요청을 생성할 때 변수 값으로 대체되어야 하며, 이를 문서에 포함하기 위해 RestDocumentationRequestBuilders를 사용한다.