Uses of Interface
org.springframework.restdocs.RestDocumentationContext
Package
Description
Core Spring REST Docs classes.
Classes for configuring Spring REST Docs.
Core classes for using Spring REST Docs with Spring Test's MockMvc.
Snippet generation.
-
Uses of RestDocumentationContext in org.springframework.restdocs
Modifier and TypeMethodDescriptionJUnitRestDocumentation.beforeOperation()
ManualRestDocumentation.beforeOperation()
RestDocumentationContextProvider.beforeOperation()
Returns aRestDocumentationContext
for the operation that is about to be performed. -
Uses of RestDocumentationContext in org.springframework.restdocs.config
Modifier and TypeMethodDescriptionabstract void
AbstractConfigurer.apply
(Map<String, Object> configuration, RestDocumentationContext context) Applies the configurer to the givenconfiguration
.void
OperationPreprocessorsConfigurer.apply
(Map<String, Object> configuration, RestDocumentationContext context) protected final void
RestDocumentationConfigurer.apply
(Map<String, Object> configuration, RestDocumentationContext context) Applies this configurer to the givenconfiguration
within the givencontext
.void
SnippetConfigurer.apply
(Map<String, Object> configuration, RestDocumentationContext context) -
Uses of RestDocumentationContext in org.springframework.restdocs.mockmvc
Modifier and TypeMethodDescriptionvoid
UriConfigurer.apply
(Map<String, Object> configuration, RestDocumentationContext context) -
Uses of RestDocumentationContext in org.springframework.restdocs.snippet
Modifier and TypeMethodDescriptionprotected final RestDocumentationContext
RestDocumentationContextPlaceholderResolver.getContext()
Returns theRestDocumentationContext
that should be used during placeholder resolution.Modifier and TypeMethodDescriptionorg.springframework.util.PropertyPlaceholderHelper.PlaceholderResolver
PlaceholderResolverFactory.create
(RestDocumentationContext context) Creates a newPropertyPlaceholderHelper.PlaceholderResolver
using the givencontext
.org.springframework.util.PropertyPlaceholderHelper.PlaceholderResolver
RestDocumentationContextPlaceholderResolverFactory.create
(RestDocumentationContext context) StandardWriterResolver.resolve
(String operationName, String snippetName, RestDocumentationContext context) WriterResolver.resolve
(String operationName, String snippetName, RestDocumentationContext restDocumentationContext) Returns a writer that can be used to write the snippet with the given name for the operation with the given name.ModifierConstructorDescriptionCreates a new placeholder resolver that will resolve placeholders using the givencontext
.