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)

我非常确定我按照解释here进行了测试设置。

我可能做错了什么？

（Spring REST docs version is 1.0.0.BUILD-SNAPSHOT）

Answer 1

异常消息试图指出你正确的方向：

找不到urlTemplate。您是否使用RestDocumentationRequestBuilders来构建请求？

您需要使用RestDocumentationRequestBuilders，以便Spring REST Docs可以捕获URL并从中提取参数。这是mentioned in the documentation，其中包含：

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

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

pathParameters文档异常（找不到urlTemplate）

1 个答案: