org.springframework.restdocs

Class RestDocumentation

java.lang.Object

org.springframework.restdocs.RestDocumentation

public abstract class RestDocumentation
extends Object

Static factory methods for documenting RESTful APIs using Spring MVC Test

Author:

Andy Wilkinson

Method Summary

Modifier and Type	Method and Description
static RestDocumentationResultHandler	document(String outputDir) Documents the API call to the given outputDir.
static RestDocumentationConfigurer	documentationConfiguration() Provides access to a MockMvcConfigurer that can be used to configure the REST documentation when building a MockMvc instance.
static ResponseModifier	modifyResponseTo(ResponsePostProcessor... responsePostProcessors) Enables the modification of the response in a MvcResult prior to it being documented.

Methods inherited from class java.lang.Object

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

Method Detail

documentationConfiguration

public static RestDocumentationConfigurer documentationConfiguration()

Provides access to a MockMvcConfigurer that can be used to configure the REST documentation when building a MockMvc instance.

Returns:

the configurer

See Also:

ConfigurableMockMvcBuilder.apply(MockMvcConfigurer)

document

public static RestDocumentationResultHandler document(String outputDir)

Documents the API call to the given outputDir.

Parameters:

outputDir - The directory to which the documentation will be written

Returns:

a Mock MVC ResultHandler that will produce the documentation

See Also:

MockMvc.perform(org.springframework.test.web.servlet.RequestBuilder), ResultActions.andDo(org.springframework.test.web.servlet.ResultHandler)

modifyResponseTo

public static ResponseModifier modifyResponseTo(ResponsePostProcessor... responsePostProcessors)

Enables the modification of the response in a MvcResult prior to it being documented. The modification is performed using the given responsePostProcessors.

Parameters:

responsePostProcessors - the post-processors to use to modify the response

Returns:

the response modifier

See Also:

ResponsePostProcessors