org.springframework.restdocs

Class ManualRestDocumentation

java.lang.Object

org.springframework.restdocs.ManualRestDocumentation

All Implemented Interfaces:

RestDocumentationContextProvider

public final class ManualRestDocumentation
extends java.lang.Object
implements RestDocumentationContextProvider

ManualRestDocumentation is used to manually manage the RestDocumentationContext. Primarly intended for use with TestNG, but suitable for use in any environment where manual management of the context is required.

Users of JUnit should use JUnitRestDocumentation and take advantage of its Rule-based support for automatic management of the context.

Since:

1.1.0

Author:

Andy Wilkinson

Constructor Summary

Constructors

Constructor and Description
ManualRestDocumentation() Creates a new ManualRestDocumentation instance that will generate snippets to <gradle/maven build path>/generated-snippet.
ManualRestDocumentation(java.lang.String outputDirectory) Creates a new ManualRestDocumentation instance that will generate snippets to the given outputDirectory.

Method Summary

Modifier and Type	Method and Description
void	afterTest() Notification that a test has completed.
RestDocumentationContext	beforeOperation() Returns a RestDocumentationContext for the operation that is about to be performed.
void	beforeTest(java.lang.Class<?> testClass, java.lang.String testMethodName) Notification that a test is about to begin.

Methods inherited from class java.lang.Object

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

Constructor Detail

ManualRestDocumentation

public ManualRestDocumentation()

Creates a new ManualRestDocumentation instance that will generate snippets to <gradle/maven build path>/generated-snippet.

ManualRestDocumentation

public ManualRestDocumentation(java.lang.String outputDirectory)

Creates a new ManualRestDocumentation instance that will generate snippets to the given outputDirectory.

Parameters:

outputDirectory - the output directory

Method Detail

beforeTest

public void beforeTest(java.lang.Class<?> testClass,
                       java.lang.String testMethodName)

Notification that a test is about to begin. Creates a RestDocumentationContext for the test on the given testClass with the given testMethodName. Must be followed by a call to afterTest() once the test has completed.

Parameters:

testClass - the test class

testMethodName - the name of the test method

Throws:

java.lang.IllegalStateException - if a context has already be created

afterTest

public void afterTest()

Notification that a test has completed. Clears the RestDocumentationContext that was previously established by a call to beforeTest(Class, String).

beforeOperation

public RestDocumentationContext beforeOperation()

Description copied from interface: RestDocumentationContextProvider

Returns a RestDocumentationContext for the operation that is about to be performed.

Specified by:

beforeOperation in interface RestDocumentationContextProvider

Returns:

the context for the operation