org.springframework.restdocs

Class ResponseModifier

java.lang.Object

org.springframework.restdocs.ResponseModifier

public final class ResponseModifier
extends Object

Modifies the response in an MvcResult by applying ResponsePostProcessors to it.

Author:

Andy Wilkinson

See Also:

RestDocumentation.modifyResponseTo(ResponsePostProcessor...)

Method Summary

Modifier and Type	Method and Description
RestDocumentationResultHandler	andDocument(String outputDir) Provides a RestDocumentationResultHandler that can be used to document the request and modified result.

Methods inherited from class java.lang.Object

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

Method Detail

andDocument

public RestDocumentationResultHandler andDocument(String outputDir)

Provides a RestDocumentationResultHandler that can be used to document the request and modified result.

Parameters:

outputDir - The directory to which the documentation will be written

Returns:

the result handler that will produce the documentation