public final class RestDocumentationContext
extends java.lang.Object
RestDocumentationContext
encapsulates the context in which the documentation of
a RESTful API is being performed.Constructor and Description |
---|
RestDocumentationContext(java.lang.Class<?> testClass,
java.lang.String testMethodName,
java.io.File outputDirectory)
Deprecated.
Since 1.1 in favor of
ManualRestDocumentation . |
Modifier and Type | Method and Description |
---|---|
java.io.File |
getOutputDirectory()
Returns the output directory to which generated snippets should be written.
|
int |
getStepCount()
Returns the current step count.
|
java.lang.Class<?> |
getTestClass()
Returns the class whose tests are currently executing.
|
java.lang.String |
getTestMethodName()
Returns the name of the test method that is currently executing.
|
@Deprecated public RestDocumentationContext(java.lang.Class<?> testClass, java.lang.String testMethodName, java.io.File outputDirectory)
ManualRestDocumentation
.RestDocumentationContext
for a test on the given
testClass
with given testMethodName
that will generate
documentation to the given outputDirectory
.testClass
- the class whose test is being executedtestMethodName
- the name of the test method that is being executedoutputDirectory
- the directory to which documentation should be written.public java.lang.Class<?> getTestClass()
public java.lang.String getTestMethodName()
public int getStepCount()
public java.io.File getOutputDirectory()