Uses of Interface
org.springframework.restdocs.RestDocumentationContext
Packages that use 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
Methods in org.springframework.restdocs that return RestDocumentationContextModifier and TypeMethodDescriptionManualRestDocumentation.beforeOperation()RestDocumentationContextProvider.beforeOperation()Returns aRestDocumentationContextfor the operation that is about to be performed. -
Uses of RestDocumentationContext in org.springframework.restdocs.config
Methods in org.springframework.restdocs.config with parameters of type RestDocumentationContextModifier and TypeMethodDescriptionabstract voidAbstractConfigurer.apply(Map<String, Object> configuration, RestDocumentationContext context) Applies the configurer to the givenconfiguration.voidOperationPreprocessorsConfigurer.apply(Map<String, Object> configuration, RestDocumentationContext context) protected final voidRestDocumentationConfigurer.apply(Map<String, Object> configuration, RestDocumentationContext context) Applies this configurer to the givenconfigurationwithin the givencontext.voidSnippetConfigurer.apply(Map<String, Object> configuration, RestDocumentationContext context) -
Uses of RestDocumentationContext in org.springframework.restdocs.mockmvc
Methods in org.springframework.restdocs.mockmvc with parameters of type RestDocumentationContextModifier and TypeMethodDescriptionvoidUriConfigurer.apply(Map<String, Object> configuration, RestDocumentationContext context) -
Uses of RestDocumentationContext in org.springframework.restdocs.snippet
Methods in org.springframework.restdocs.snippet that return RestDocumentationContextModifier and TypeMethodDescriptionprotected final RestDocumentationContextRestDocumentationContextPlaceholderResolver.getContext()Returns theRestDocumentationContextthat should be used during placeholder resolution.Methods in org.springframework.restdocs.snippet with parameters of type RestDocumentationContextModifier and TypeMethodDescriptionorg.springframework.util.PropertyPlaceholderHelper.PlaceholderResolverPlaceholderResolverFactory.create(RestDocumentationContext context) Creates a newPropertyPlaceholderHelper.PlaceholderResolverusing the givencontext.org.springframework.util.PropertyPlaceholderHelper.PlaceholderResolverRestDocumentationContextPlaceholderResolverFactory.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.Constructors in org.springframework.restdocs.snippet with parameters of type RestDocumentationContextModifierConstructorDescriptionCreates a new placeholder resolver that will resolve placeholders using the givencontext.