org.springframework.restdocs

Class JUnitRestDocumentation

java.lang.Object

org.springframework.restdocs.JUnitRestDocumentation

All Implemented Interfaces:

org.junit.rules.TestRule, RestDocumentationContextProvider

public class JUnitRestDocumentation
extends Object
implements RestDocumentationContextProvider, org.junit.rules.TestRule

A JUnit TestRule used to automatically manage the RestDocumentationContext.

Since:

1.1.0

Author:

Andy Wilkinson

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
org.junit.runners.model.Statement	apply(org.junit.runners.model.Statement base, org.junit.runner.Description description)
RestDocumentationContext	beforeOperation() Returns a RestDocumentationContext for the operation that is about to be performed.

Methods inherited from class java.lang.Object

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

Constructor Detail

JUnitRestDocumentation

public JUnitRestDocumentation()

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

JUnitRestDocumentation

public JUnitRestDocumentation(String outputDirectory)

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

Parameters:

outputDirectory - the output directory

Method Detail

apply

public org.junit.runners.model.Statement apply(org.junit.runners.model.Statement base,
                                               org.junit.runner.Description description)

Specified by:

apply in interface org.junit.rules.TestRule

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