Package | Description |
---|---|
org.springframework.restdocs |
Core Spring REST Docs classes.
|
org.springframework.restdocs.config |
Classes for configuring Spring REST Docs.
|
org.springframework.restdocs.mockmvc |
Core classes for using Spring REST Docs with Spring Test's MockMvc.
|
org.springframework.restdocs.snippet |
Snippet generation.
|
Modifier and Type | Method and Description |
---|---|
RestDocumentationContext |
RestDocumentationContextProvider.beforeOperation()
Returns a
RestDocumentationContext for the operation that is about to be
performed. |
RestDocumentationContext |
ManualRestDocumentation.beforeOperation() |
RestDocumentationContext |
JUnitRestDocumentation.beforeOperation() |
Modifier and Type | Method and Description |
---|---|
void |
OperationPreprocessorsConfigurer.apply(java.util.Map<java.lang.String,java.lang.Object> configuration,
RestDocumentationContext context) |
protected void |
RestDocumentationConfigurer.apply(java.util.Map<java.lang.String,java.lang.Object> configuration,
RestDocumentationContext context)
Applies this configurer to the given
configuration within the given
context . |
abstract void |
AbstractConfigurer.apply(java.util.Map<java.lang.String,java.lang.Object> configuration,
RestDocumentationContext context)
Applies the configurer to the given
configuration . |
void |
SnippetConfigurer.apply(java.util.Map<java.lang.String,java.lang.Object> configuration,
RestDocumentationContext context) |
Modifier and Type | Method and Description |
---|---|
void |
UriConfigurer.apply(java.util.Map<java.lang.String,java.lang.Object> configuration,
RestDocumentationContext context) |
Modifier and Type | Method and Description |
---|---|
protected RestDocumentationContext |
RestDocumentationContextPlaceholderResolver.getContext()
Returns the
RestDocumentationContext that should be used during placeholder
resolution. |
Modifier and Type | Method and Description |
---|---|
org.springframework.util.PropertyPlaceholderHelper.PlaceholderResolver |
RestDocumentationContextPlaceholderResolverFactory.create(RestDocumentationContext context) |
org.springframework.util.PropertyPlaceholderHelper.PlaceholderResolver |
PlaceholderResolverFactory.create(RestDocumentationContext context)
Creates a new
PropertyPlaceholderHelper.PlaceholderResolver using the given context . |
java.io.Writer |
StandardWriterResolver.resolve(java.lang.String operationName,
java.lang.String snippetName,
RestDocumentationContext context) |
java.io.Writer |
WriterResolver.resolve(java.lang.String operationName,
java.lang.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.
|
Constructor and Description |
---|
RestDocumentationContextPlaceholderResolver(RestDocumentationContext context)
Creates a new placeholder resolver that will resolve placeholders using the given
context . |