From 3ec945fe58845893847fd1e931f00ab0279f36b8 Mon Sep 17 00:00:00 2001 From: Andy Wilkinson Date: Fri, 22 Jul 2016 14:30:09 +0100 Subject: [PATCH] Make it clearer how to use RestDocumentationResultHandler.document Closes gh-255 --- .../mockmvc/RestDocumentationResultHandler.java | 17 ++++++++++++++--- 1 file changed, 14 insertions(+), 3 deletions(-) diff --git a/spring-restdocs-mockmvc/src/main/java/org/springframework/restdocs/mockmvc/RestDocumentationResultHandler.java b/spring-restdocs-mockmvc/src/main/java/org/springframework/restdocs/mockmvc/RestDocumentationResultHandler.java index 5a85fc5c..1522fa2d 100644 --- a/spring-restdocs-mockmvc/src/main/java/org/springframework/restdocs/mockmvc/RestDocumentationResultHandler.java +++ b/spring-restdocs-mockmvc/src/main/java/org/springframework/restdocs/mockmvc/RestDocumentationResultHandler.java @@ -24,6 +24,7 @@ import org.springframework.mock.web.MockHttpServletResponse; import org.springframework.restdocs.generate.RestDocumentationGenerator; import org.springframework.restdocs.snippet.Snippet; import org.springframework.test.web.servlet.MvcResult; +import org.springframework.test.web.servlet.ResultActions; import org.springframework.test.web.servlet.ResultHandler; import org.springframework.util.Assert; @@ -60,7 +61,8 @@ public class RestDocumentationResultHandler implements ResultHandler { * * @param snippets the snippets to add * @return this {@code RestDocumentationResultHandler} - * @deprecated since 1.1 in favor of {@link #document(Snippet...)} + * @deprecated since 1.1 in favor of {@link #document(Snippet...)} and passing the + * return value into {@link ResultActions#andDo(ResultHandler)} */ @Deprecated public RestDocumentationResultHandler snippets(Snippet... snippets) { @@ -69,8 +71,17 @@ public class RestDocumentationResultHandler implements ResultHandler { } /** - * Creates a new {@link RestDocumentationResultHandler} that will produce - * documentation using the given {@code snippets}. + * Creates a new {@link RestDocumentationResultHandler} to be passed into + * {@link ResultActions#andDo(ResultHandler)} that will produce documentation using + * the given {@code snippets}. For example: + * + * 
+	 * this.mockMvc.perform(MockMvcRequestBuilders.get("/search"))
+	 *     .andExpect(status().isOk())
+	 *     .andDo(this.documentationHandler.document(responseFields(
+	 *          fieldWithPath("page").description("The requested Page")
+	 *     ));
+	 *
* * @param snippets the snippets * @return the new result handler