| Package | Description |
|---|---|
| org.springframework.restdocs.config |
Classes for configuring Spring REST Docs.
|
| org.springframework.restdocs.snippet |
Snippet generation.
|
| org.springframework.restdocs.templates |
Template API used to render documentation snippets.
|
| Modifier and Type | Field and Description |
|---|---|
static TemplateFormat |
SnippetConfigurer.DEFAULT_TEMPLATE_FORMAT
The default format for documentation snippets.
|
| Modifier and Type | Method and Description |
|---|---|
TYPE |
SnippetConfigurer.withTemplateFormat(TemplateFormat format)
Configures the format of the documentation snippet templates.
|
| Constructor and Description |
|---|
StandardWriterResolver(PlaceholderResolverFactory placeholderResolverFactory,
java.lang.String encoding,
TemplateFormat templateFormat)
Creates a new
StandardWriterResolver that will use a
PropertyPlaceholderHelper.PlaceholderResolver created from the given
placeholderResolverFactory to resolve any placeholders in the
operationName. |
| Modifier and Type | Method and Description |
|---|---|
static TemplateFormat |
TemplateFormats.asciidoctor()
Returns the Asciidoctor template format with the ID
asciidoctor and the
file extension adoc. |
static TemplateFormat |
TemplateFormats.markdown()
Returns the Markdown template format with the ID
markdown and the file
extension md. |
| Constructor and Description |
|---|
StandardTemplateResourceResolver(TemplateFormat templateFormat)
Creates a new
StandardTemplateResourceResolver that will produce default
template resources formatted with the given templateFormat. |