- WebTestClientOperationPreprocessorsConfigurer - Class in org.springframework.restdocs.webtestclient
-
A configurer that can be used to configure the operation preprocessors.
- WebTestClientRestDocumentation - Class in org.springframework.restdocs.webtestclient
-
Static factory methods for documenting RESTful APIs using WebFlux's
WebTestClient
.
- WebTestClientRestDocumentationConfigurer - Class in org.springframework.restdocs.webtestclient
-
- WebTestClientSnippetConfigurer - Class in org.springframework.restdocs.webtestclient
-
A
SnippetConfigurer
for WebFlux that can be used to configure the generated
documentation snippets.
- withAdditionalDefaults(Snippet...) - Method in class org.springframework.restdocs.config.SnippetConfigurer
-
Configures additional documentation snippets that will be produced by default.
- withDefaults(Snippet...) - Method in class org.springframework.restdocs.config.SnippetConfigurer
-
Configures the documentation snippets that will be produced by default.
- withEncoding(String) - Method in class org.springframework.restdocs.config.SnippetConfigurer
-
Configures any documentation snippets to be written using the given
encoding
.
- withHost(String) - Method in class org.springframework.restdocs.mockmvc.UriConfigurer
-
Configures any documented URIs to use the given host
.
- withPort(int) - Method in class org.springframework.restdocs.mockmvc.UriConfigurer
-
Configures any documented URIs to use the given port
.
- withRequestDefaults(OperationPreprocessor...) - Method in class org.springframework.restdocs.config.OperationPreprocessorsConfigurer
-
Configures the default operation request preprocessors.
- withResponseDefaults(OperationPreprocessor...) - Method in class org.springframework.restdocs.config.OperationPreprocessorsConfigurer
-
Configures the default operation response preprocessors.
- withScheme(String) - Method in class org.springframework.restdocs.mockmvc.UriConfigurer
-
Configures any documented URIs to use the given scheme
.
- withSnippets(Snippet...) - Method in class org.springframework.restdocs.generate.RestDocumentationGenerator
-
- withSubsectionId(String) - Method in class org.springframework.restdocs.payload.FieldPathPayloadSubsectionExtractor
-
- withSubsectionId(String) - Method in interface org.springframework.restdocs.payload.PayloadSubsectionExtractor
-
Returns an extractor with the given subsectionId
.
- withTemplateFormat(TemplateFormat) - Method in class org.springframework.restdocs.config.SnippetConfigurer
-
Configures the format of the documentation snippet templates.
- writerResolver(WriterResolver) - Method in class org.springframework.restdocs.config.RestDocumentationConfigurer
-
Configures the
WriterResolver
that will be used to resolve a writer for a
snippet.
- WriterResolver - Interface in org.springframework.restdocs.snippet
-
A WriterResolver
is used to access the Writer
that should be used to
write a snippet for an operation that is being documented.