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
void	handle(MvcResult result)
RestDocumentationResultHandler	snippets(Snippet... snippets) Adds the given snippets such that that are documented when this result handler is called.

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

public RestDocumentationResultHandler snippets(Snippet... snippets)

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

Parameters:

snippets - the snippets to add

Returns:

this ResultDocumentationResultHandler