pathParameters文档异常(未找到urlTemplate)

Question

当使用pathParameters记录URI路径参数时，如下所示

@Test
public void documentGetRouteById() throws Exception {
    this.mockMvc.perform(get("/route/{id}", "FooBar")).andExpect(status().isOk())
            .andDo(document("api-getRouteById",
                    pathParameters(parameterWithName("id").description("die Routen ID"))));
}

得到以下异常

java.lang.IllegalArgumentException: urlTemplate not found. Did you use RestDocumentationRequestBuilders to build the request?
    at org.springframework.util.Assert.notNull(Assert.java:112)
    at org.springframework.restdocs.request.PathParametersSnippet.extractUrlTemplate(PathParametersSnippet.java:95)
    at org.springframework.restdocs.request.PathParametersSnippet.extractActualParameters(PathParametersSnippet.java:82)
    at org.springframework.restdocs.request.AbstractParametersSnippet.verifyParameterDescriptors(AbstractParametersSnippet.java:77)
    at org.springframework.restdocs.request.AbstractParametersSnippet.createModel(AbstractParametersSnippet.java:65)
    at org.springframework.restdocs.request.PathParametersSnippet.createModel(PathParametersSnippet.java:67)
    at org.springframework.restdocs.snippet.TemplatedSnippet.document(TemplatedSnippet.java:64)
    at org.springframework.restdocs.mockmvc.RestDocumentationResultHandler.handle(RestDocumentationResultHandler.java:101)
    at org.springframework.test.web.servlet.MockMvc$1.andDo(MockMvc.java:158)

我很确定我做了这里解释的测试设置。

我可能做错了什么?

(Spring REST文档版本为1.0.0.BUILD-SNAPSHOT)

Answer 1

异常消息试图为您指出正确的方向:

urlTemplate未找到。您是否使用RestDocumentationRequestBuilders来构建请求?

您需要使用RestDocumentationRequestBuilders，以便Spring REST文档可以捕获URL并从中提取参数。这在文档中提到:

要使路径参数可用于文档，必须使用RestDocumentationRequestBuilders而不是MockMvcRequestBuilders上的方法之一来构建请求。

将MockMvcRequestBuilders.get的静态导入替换为RestDocumentationRequestBuilders.get的静态导入应该可以解决问题。