org.springframework.restdocs.mockmvc

Class RestDocumentationResultHandler

java.lang.Object

org.springframework.restdocs.mockmvc.RestDocumentationResultHandler

All Implemented Interfaces:

ResultHandler

public class RestDocumentationResultHandler
extends Object
implements ResultHandler

A Spring MVC Test ResultHandler for documenting RESTful APIs.

Author:

Andy Wilkinson, Andreas Evers

See Also:

MockMvcRestDocumentation.document(String, Snippet...)

Method Summary

Modifier and Type	Method and Description
RestDocumentationResultHandler	document(Snippet... snippets) Creates a new RestDocumentationResultHandler to be passed into ResultActions.andDo(ResultHandler) that will produce documentation using the given snippets.
protected RestDocumentationGenerator<MockHttpServletRequest,MockHttpServletResponse>	getDelegate() Returns the RestDocumentationGenerator that is used as a delegate.
void	handle(MvcResult result)
RestDocumentationResultHandler	snippets(Snippet... snippets) Deprecated. since 1.1 in favor of document(Snippet...) and passing the return value into ResultActions.andDo(ResultHandler)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

handle

public void handle(MvcResult result)
            throws Exception

Specified by:

handle in interface ResultHandler

Throws:

Exception

snippets

@Deprecated
public RestDocumentationResultHandler snippets(Snippet... snippets)

Deprecated. since 1.1 in favor of document(Snippet...) and passing the return value into ResultActions.andDo(ResultHandler)

Adds the given snippets such that they are documented when this result handler is called.

Parameters:

snippets - the snippets to add

Returns:

this RestDocumentationResultHandler

document

public RestDocumentationResultHandler document(Snippet... snippets)

Creates a new RestDocumentationResultHandler to be passed into ResultActions.andDo(ResultHandler) that will produce documentation using the given snippets. For example:

 this.mockMvc.perform(MockMvcRequestBuilders.get("/search"))
     .andExpect(status().isOk())
     .andDo(this.documentationHandler.document(responseFields(
          fieldWithPath("page").description("The requested Page")
     ));
 

Parameters:

snippets - the snippets

Returns:

the new result handler

getDelegate

protected final RestDocumentationGenerator<MockHttpServletRequest,MockHttpServletResponse> getDelegate()

Returns the RestDocumentationGenerator that is used as a delegate.

Returns:

the delegate