JUnitRestDocumentation
@Deprecated public class RestDocumentation extends java.lang.Object implements org.junit.rules.TestRule, RestDocumentationContextProvider
TestRule
used to bootstrap the generation of REST documentation from
JUnit tests.Constructor and Description |
---|
RestDocumentation()
Deprecated.
Creates a new
RestDocumentation instance that will generate snippets to the
to <gradle/maven build path>/generated-snippet. |
RestDocumentation(java.lang.String outputDirectory)
Deprecated.
Creates a new
RestDocumentation 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)
Deprecated.
|
RestDocumentationContext |
beforeOperation()
Deprecated.
Returns a
RestDocumentationContext for the operation that is about to be
performed. |
public RestDocumentation()
RestDocumentation
instance that will generate snippets to the
to <gradle/maven build path>/generated-snippet.public RestDocumentation(java.lang.String outputDirectory)
RestDocumentation
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