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