- ManualRestDocumentation - Class in org.springframework.restdocs
-
- ManualRestDocumentation() - Constructor for class org.springframework.restdocs.ManualRestDocumentation
-
Creates a new ManualRestDocumentation
instance that will generate snippets
to <gradle/maven build path>/generated-snippet.
- ManualRestDocumentation(String) - Constructor for class org.springframework.restdocs.ManualRestDocumentation
-
Creates a new ManualRestDocumentation
instance that will generate snippets
to the given outputDirectory
.
- markdown() - Static method in class org.springframework.restdocs.templates.TemplateFormats
-
Returns the Markdown template format with the ID markdown
and the file
extension md
.
- maskLinks() - Static method in class org.springframework.restdocs.operation.preprocess.Preprocessors
-
Returns an OperationPreprocessor
that will mask the href of hypermedia
links in the request or response.
- maskLinks(String) - Static method in class org.springframework.restdocs.operation.preprocess.Preprocessors
-
Returns an OperationPreprocessor
that will mask the href of hypermedia
links in the request or response.
- MockMvcRestDocumentation - Class in org.springframework.restdocs.mockmvc
-
Static factory methods for documenting RESTful APIs using Spring MVC Test.
- MockMvcRestDocumentationConfigurer - Class in org.springframework.restdocs.mockmvc
-
- MockMvcSnippetConfigurer - Class in org.springframework.restdocs.mockmvc
-
A configurer that can be used to configure the generated documentation snippets.
- ModelCreationException - Exception in org.springframework.restdocs.snippet
-
An exception that can be thrown by a
TemplatedSnippet
to indicate that a
failure has occurred during model creation.
- ModelCreationException(Throwable) - Constructor for exception org.springframework.restdocs.snippet.ModelCreationException
-
Creates a new ModelCreationException
with the given cause
.
- ModelCreationException(String, Throwable) - Constructor for exception org.springframework.restdocs.snippet.ModelCreationException
-
Creates a new ModelCreationException
with the given message
and
cause
.
- modifyContent(byte[], MediaType) - Method in interface org.springframework.restdocs.operation.preprocess.ContentModifier
-
Returns modified content based on the given originalContent
.
- modifyContent(byte[], MediaType) - Method in class org.springframework.restdocs.operation.preprocess.PrettyPrintingContentModifier
-
- modifyParameters() - Static method in class org.springframework.restdocs.operation.preprocess.Preprocessors
-
Returns a ParametersModifyingOperationPreprocessor
that can then be
configured to modify the parameters of the request.
- modifyUris() - Static method in class org.springframework.restdocs.restassured.operation.preprocess.RestAssuredPreprocessors
-
Deprecated.
Returns a UriModifyingOperationPreprocessor
that will modify URIs in the
request or response by changing one or more of their host, scheme, and port.
- modifyUris() - Static method in class org.springframework.restdocs.restassured3.operation.preprocess.RestAssuredPreprocessors
-
Returns a UriModifyingOperationPreprocessor
that will modify URIs in the
request or response by changing one or more of their host, scheme, and port.
- multiLineFormat() - Static method in class org.springframework.restdocs.cli.CliDocumentation
-
Creates a new CommandFormatter
that produces multi-line output.
- MustacheTemplate - Class in org.springframework.restdocs.templates.mustache
-
- MustacheTemplate(Template) - Constructor for class org.springframework.restdocs.templates.mustache.MustacheTemplate
-
Creates a new MustacheTemplate
that adapts the given delegate
.
- MustacheTemplate(Template, Map<String, Object>) - Constructor for class org.springframework.restdocs.templates.mustache.MustacheTemplate
-
Creates a new MustacheTemplate
that adapts the given delegate
.
- MustacheTemplateEngine - Class in org.springframework.restdocs.templates.mustache
-
- MustacheTemplateEngine(TemplateResourceResolver) - Constructor for class org.springframework.restdocs.templates.mustache.MustacheTemplateEngine
-
Creates a new MustacheTemplateEngine
that will use the given
templateResourceResolver
to resolve template paths.
- MustacheTemplateEngine(TemplateResourceResolver, Mustache.Compiler) - Constructor for class org.springframework.restdocs.templates.mustache.MustacheTemplateEngine
-
Creates a new MustacheTemplateEngine
that will use the given
templateResourceResolver
to resolve templates and the given
compiler
to compile them.
- MustacheTemplateEngine(TemplateResourceResolver, Mustache.Compiler, Map<String, Object>) - Constructor for class org.springframework.restdocs.templates.mustache.MustacheTemplateEngine
-
Creates a new MustacheTemplateEngine
that will use the given
templateResourceResolver
to resolve templates and the given
compiler
to compile them.