Index
All Classes and Interfaces|All Packages|Constant Field Values|Serialized Form
M
- ManualRestDocumentation - Class in org.springframework.restdocs
-
ManualRestDocumentation
is used to manually manage theRestDocumentationContext
. - ManualRestDocumentation() - Constructor for class org.springframework.restdocs.ManualRestDocumentation
-
Creates a new
ManualRestDocumentation
instance that will generate snippets to <gradle/maven build path>/generated-snippets. - ManualRestDocumentation(String) - Constructor for class org.springframework.restdocs.ManualRestDocumentation
-
Creates a new
ManualRestDocumentation
instance that will generate snippets to the givenoutputDirectory
. - markdown() - Static method in class org.springframework.restdocs.templates.TemplateFormats
-
Returns the Markdown template format with the ID
markdown
and the file extensionmd
. - 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. - MockMvcOperationPreprocessorsConfigurer - Class in org.springframework.restdocs.mockmvc
-
A configurer that can be used to configure the operation preprocessors.
- 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
-
A MockMvc-specific
RestDocumentationConfigurer
. - 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(String, Throwable) - Constructor for exception org.springframework.restdocs.snippet.ModelCreationException
-
Creates a new
ModelCreationException
with the givenmessage
andcause
. - ModelCreationException(Throwable) - Constructor for exception org.springframework.restdocs.snippet.ModelCreationException
-
Creates a new
ModelCreationException
with the givencause
. - 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
- modifyHeaders() - Static method in class org.springframework.restdocs.operation.preprocess.Preprocessors
-
Returns a
HeadersModifyingOperationPreprocessor
that can then be configured to modify the headers of the request. - 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.operation.preprocess.Preprocessors
-
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. - multipart(String, Object...) - Static method in class org.springframework.restdocs.mockmvc.RestDocumentationRequestBuilders
-
Create a
MockMultipartHttpServletRequestBuilder
for a multipart request. - multipart(URI) - Static method in class org.springframework.restdocs.mockmvc.RestDocumentationRequestBuilders
-
Create a
MockMultipartHttpServletRequestBuilder
for a multipart request. - 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 givendelegate
. - MustacheTemplate(Template, Map<String, Object>) - Constructor for class org.springframework.restdocs.templates.mustache.MustacheTemplate
-
Creates a new
MustacheTemplate
that adapts the givendelegate
. - 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 giventemplateResourceResolver
to resolve template paths. - MustacheTemplateEngine(TemplateResourceResolver, Charset) - Constructor for class org.springframework.restdocs.templates.mustache.MustacheTemplateEngine
-
Creates a new
MustacheTemplateEngine
that will use the giventemplateResourceResolver
to resolve template paths, reading them using the giventemplateEncoding
. - MustacheTemplateEngine(TemplateResourceResolver, Charset, Mustache.Compiler) - Constructor for class org.springframework.restdocs.templates.mustache.MustacheTemplateEngine
-
Creates a new
MustacheTemplateEngine
that will use the giventemplateResourceResolver
to resolve templates and the givencompiler
to compile them. - MustacheTemplateEngine(TemplateResourceResolver, Charset, Mustache.Compiler, Map<String, Object>) - Constructor for class org.springframework.restdocs.templates.mustache.MustacheTemplateEngine
-
Creates a new
MustacheTemplateEngine
that will use the giventemplateResourceResolver
to resolve templates. - MustacheTemplateEngine(TemplateResourceResolver, Mustache.Compiler) - Constructor for class org.springframework.restdocs.templates.mustache.MustacheTemplateEngine
-
Creates a new
MustacheTemplateEngine
that will use the giventemplateResourceResolver
to resolve templates and the givencompiler
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 giventemplateResourceResolver
to resolve templates.
All Classes and Interfaces|All Packages|Constant Field Values|Serialized Form