java - tutorial - spring rest docs example

Excepción de la documentación de pathParameters(urlTemplate no encontrado)

Question

Cuando se utiliza pathParameters para documentar los parámetros de la ruta URI como se muestra a continuación

@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"))));
}

Me sale el siguiente permiso

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)

Estoy bastante seguro de que hice la configuración de prueba como se explica here .

¿Qué podría haber hecho mal?

(La versión de Spring REST docs es 1.0.0.BUILD-SNAPSHOT)

Answer 1

El mensaje de excepción está intentando indicarle la dirección correcta:

urlTemplate no encontrado. ¿Usó RestDocumentationRequestBuilders para generar la solicitud?

RestDocumentationRequestBuilders usar RestDocumentationRequestBuilders para que Spring REST Docs pueda capturar la URL y extraer los parámetros de ella. Esto se menciona en la documentación donde dice:

Para que los parámetros de ruta estén disponibles para la documentación, la solicitud se debe crear utilizando uno de los métodos en RestDocumentationRequestBuilders en lugar de MockMvcRequestBuilders.

Reemplazar su importación estática de MockMvcRequestBuilders.get con uno para RestDocumentationRequestBuilders.get debería resolver el problema.