public class JUnitRestDocumentation extends Object implements RestDocumentationContextProvider, org.junit.rules.TestRule
TestRule
used to automatically manage the
RestDocumentationContext
.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 . |
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. |
public JUnitRestDocumentation()
JUnitRestDocumentation
instance that will generate snippets
to <gradle/maven build path>/generated-snippet.public JUnitRestDocumentation(String outputDirectory)
JUnitRestDocumentation
instance that will generate snippets
to the given outputDirectory
.outputDirectory
- the output directorypublic org.junit.runners.model.Statement apply(org.junit.runners.model.Statement base, org.junit.runner.Description description)
apply
in interface org.junit.rules.TestRule
public RestDocumentationContext beforeOperation()
RestDocumentationContextProvider
RestDocumentationContext
for the operation that is about to be
performed.beforeOperation
in interface RestDocumentationContextProvider