org.springframework.restdocs

Class RestDocumentationResultHandler

java.lang.Object

org.springframework.restdocs.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:

RestDocumentation.document(String)

Method Summary

Modifier and Type	Method and Description
void	handle(MvcResult result)
RestDocumentationResultHandler	withLinks(LinkDescriptor... descriptors) Document the links in the response using the given descriptors.
RestDocumentationResultHandler	withLinks(LinkExtractor linkExtractor, LinkDescriptor... descriptors) Document the links in the response using the given descriptors.
RestDocumentationResultHandler	withQueryParameters(ParameterDescriptor... descriptors) Documents the parameters in the request's query string using the given descriptors.
RestDocumentationResultHandler	withRequestFields(FieldDescriptor... descriptors) Document the fields in the request using the given descriptors.
RestDocumentationResultHandler	withResponseFields(FieldDescriptor... descriptors) Document the fields in the response using the given descriptors.

Methods inherited from class java.lang.Object

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

Method Detail

withLinks

public RestDocumentationResultHandler withLinks(LinkDescriptor... descriptors)

Document the links in the response using the given descriptors. The links are extracted from the response based on its content type.

If a link is present in the response but is not described by one of the descriptors a failure will occur when this handler is invoked. Similarly, if a link is described but is not present in the response a failure will also occur when this handler is invoked.

Parameters:

descriptors - the link descriptors

Returns:

this

See Also:

HypermediaDocumentation.linkWithRel(String), LinkExtractors.extractorForContentType(String)

withLinks

public RestDocumentationResultHandler withLinks(LinkExtractor linkExtractor,
                                                LinkDescriptor... descriptors)

Document the links in the response using the given descriptors. The links are extracted from the response using the given linkExtractor.

If a link is present in the response but is not described by one of the descriptors a failure will occur when this handler is invoked. Similarly, if a link is described but is not present in the response a failure will also occur when this handler is invoked.

Parameters:

linkExtractor - used to extract the links from the response

descriptors - the link descriptors

Returns:

this

See Also:

HypermediaDocumentation.linkWithRel(String)

withRequestFields

public RestDocumentationResultHandler withRequestFields(FieldDescriptor... descriptors)

Document the fields in the request using the given descriptors.

If a field is present in the request but is not described by one of the descriptors a failure will occur when this handler is invoked. Similarly, if a field is described but is not present in the request a failure will also occur when this handler is invoked.

Parameters:

descriptors - the link descriptors

Returns:

this

See Also:

PayloadDocumentation.fieldWithPath(String)

withResponseFields

public RestDocumentationResultHandler withResponseFields(FieldDescriptor... descriptors)

Document the fields in the response using the given descriptors.

If a field is present in the response but is not described by one of the descriptors a failure will occur when this handler is invoked. Similarly, if a field is described but is not present in the response a failure will also occur when this handler is invoked.

Parameters:

descriptors - the link descriptors

Returns:

this

See Also:

PayloadDocumentation.fieldWithPath(String)

withQueryParameters

public RestDocumentationResultHandler withQueryParameters(ParameterDescriptor... descriptors)

Documents the parameters in the request's query string using the given descriptors.

If a parameter is present in the query string but is not described by one of the descriptors a failure will occur when this handler is invoked. Similarly, if a parameter is described but is not present in the request a failure will also occur when this handler is invoked.

Parameters:

descriptors - the parameter descriptors

Returns:

this

See Also:

RequestDocumentation.parameterWithName(String)

handle

public void handle(MvcResult result)
            throws Exception

Specified by:

handle in interface ResultHandler

Throws:

Exception