public abstract class RequestDocumentation extends Object
| Modifier and Type | Method and Description |
|---|---|
static SnippetWritingResultHandler |
documentQueryParameters(String outputDir,
ParameterDescriptor... descriptors)
Creates a
SnippetWritingResultHandler that will produce a snippet
documenting a request's query parameters |
static ParameterDescriptor |
parameterWithName(String name)
Creates a
ParameterDescriptor that describes a query string parameter with
the given name. |
public static SnippetWritingResultHandler documentQueryParameters(String outputDir, ParameterDescriptor... descriptors)
SnippetWritingResultHandler that will produce a snippet
documenting a request's query parametersoutputDir - The directory to which the snippet should be writtendescriptors - The descriptions of the parameters in the request's query stringRestDocumentationResultHandler.withQueryParameters(ParameterDescriptor...)public static ParameterDescriptor parameterWithName(String name)
ParameterDescriptor that describes a query string parameter with
the given name.name - The name of the parameterParameterDescriptor ready for further configurationRestDocumentationResultHandler.withQueryParameters(ParameterDescriptor...)