S - the concrete type of the SnippetConfigurerP - the concrete type of the OperationPreprocessorsConfigurerT - the concrete type of this configurer, to be returned from methods that
support chainingpublic abstract class RestDocumentationConfigurer<S extends AbstractConfigurer,P extends AbstractConfigurer,T> extends Object
| Constructor and Description |
|---|
RestDocumentationConfigurer() |
| Modifier and Type | Method and Description |
|---|---|
protected void |
apply(Map<String,Object> configuration,
RestDocumentationContext context)
Applies this configurer to the given
configuration within the given
context. |
abstract P |
operationPreprocessors()
Returns an
OperationPreprocessorsConfigurer that can be used to configure
the operation request and response preprocessors that will be used. |
abstract S |
snippets()
Returns a
SnippetConfigurer that can be used to configure the snippets that
will be generated. |
T |
templateEngine(TemplateEngine templateEngine)
Configures the
TemplateEngine that will be used for snippet rendering. |
T |
writerResolver(WriterResolver writerResolver)
Configures the
WriterResolver that will be used to resolve a writer for a
snippet. |
public abstract S snippets()
SnippetConfigurer that can be used to configure the snippets that
will be generated.public abstract P operationPreprocessors()
OperationPreprocessorsConfigurer that can be used to configure
the operation request and response preprocessors that will be used.public final T templateEngine(TemplateEngine templateEngine)
TemplateEngine that will be used for snippet rendering.templateEngine - the template engine to usethispublic final T writerResolver(WriterResolver writerResolver)
WriterResolver that will be used to resolve a writer for a
snippet.writerResolver - the writer resolver to usethisprotected final void apply(Map<String,Object> configuration, RestDocumentationContext context)
configuration within the given
context.configuration - the configurationcontext - the current context