[Spring REST Docs][오류] urlTemplate not found.

spring rest docs를 프로젝트에 적용하던 중 위와 같은 오류가 발생하였다.

api 문서화를 위하여 pathParameters 를 테스트 코드에 추가하였을때 발생하였다.

 

Spring REST 문서가 URL을 캡처하고 매개 변수를 추출할 수 있도록 RestDocumentationRequestBuilders를 사용해야 합니다. 이는 문서에 다음과 같이 언급되어 있습니다:

경로 매개 변수를 문서에 사용할 수 있게 하려면 MockMvcRequestBuilders가 아닌 RestDocumentationRequestBuilders의 메서드 중 하나를 사용하여 요청을 빌드해야 합니다.

MockMvcRequestBuilders.get의 정적 임포트를 RestDocumentationRequestBuilders.get의 정적 임포트로 바꾸면 문제가 해결됩니다.
(deepl 번역)

pathParameters documentation exception (urlTemplate not found)

 

//변경 전
ResultActions result = mvc.perform(MockMvcRequestBuilders.post("/api/v1/group/{groupId}/join", 1L)
        .session(session));
       

//변경 후
ResultActions result = mvc.perform(RestDocumentationRequestBuilders.post("/api/v1/group/{groupId}/join", 1L)
        .session(session));

변경 후에는 오류 없이 정상적으로 테스트가 통과하였다.