Uses of Interface
org.springframework.restdocs.templates.TemplateFormat
Packages that use TemplateFormat
Package
Description
Classes for configuring Spring REST Docs.
Snippet generation.
Template API used to render documentation snippets.
-
Uses of TemplateFormat in org.springframework.restdocs.config
Fields in org.springframework.restdocs.config declared as TemplateFormatModifier and TypeFieldDescriptionstatic final TemplateFormat
SnippetConfigurer.DEFAULT_TEMPLATE_FORMAT
The default format for documentation snippets.Methods in org.springframework.restdocs.config with parameters of type TemplateFormatModifier and TypeMethodDescriptionSnippetConfigurer.withTemplateFormat
(TemplateFormat format) Configures the format of the documentation snippet templates. -
Uses of TemplateFormat in org.springframework.restdocs.snippet
Constructors in org.springframework.restdocs.snippet with parameters of type TemplateFormatModifierConstructorDescriptionStandardWriterResolver
(PlaceholderResolverFactory placeholderResolverFactory, String encoding, TemplateFormat templateFormat) Creates a newStandardWriterResolver
that will use aPropertyPlaceholderHelper.PlaceholderResolver
created from the givenplaceholderResolverFactory
to resolve any placeholders in theoperationName
. -
Uses of TemplateFormat in org.springframework.restdocs.templates
Methods in org.springframework.restdocs.templates that return TemplateFormatModifier and TypeMethodDescriptionstatic TemplateFormat
TemplateFormats.asciidoctor()
Returns the Asciidoctor template format with the IDasciidoctor
and the file extensionadoc
.static TemplateFormat
TemplateFormats.markdown()
Returns the Markdown template format with the IDmarkdown
and the file extensionmd
.Constructors in org.springframework.restdocs.templates with parameters of type TemplateFormatModifierConstructorDescriptionStandardTemplateResourceResolver
(TemplateFormat templateFormat) Creates a newStandardTemplateResourceResolver
that will produce default template resources formatted with the giventemplateFormat
.