Spring/spring-boot
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Polish "Document how to parameterize REST Docs' output dir with WebTestClient"

Browse Source 
See gh-27755
This commit is contained in:
Andy Wilkinson
2021-08-23 15:36:16 +01:00
parent c83f6ebaa2
commit 990b766847
2 changed files with 16 additions and 12 deletions
Download Patch File Download Diff File Expand all files Collapse all files

10
spring-boot-project/spring-boot-docs/src/docs/asciidoc/spring-boot-features.adoc
View File

@@ -8063,14 +8063,12 @@ If you require more control over Spring REST Docs configuration than offered by
include::{code-examples}/test/autoconfigure/restdocs/webclient/AdvancedConfigurationExample.java[tag=configuration]
----
If you want to make use of Spring REST Docs support for a parameterized output directory, you can create a `WebTestClientBuilderCustomizer` bean.
The auto-configuration calls this `WebTestClientBuilderCustomizer` in order to create the `WebTestClient` bean for the current context
with the consumer provided in the parameter of the method `entityExchangeResultConsumer`.
The following example shows a `WebTestClientBuilderCustomizer` being defined:
If you want to make use of Spring REST Docs support for a parameterized output directory, you can use a `WebTestClientBuilderCustomizer` to configure a consumer for every entity exchange result.
The following example shows such a `WebTestClientBuilderCustomizer` being defined:
[source,java,indent=0,subs="verbatim"]
[source,java,indent=0]
----
include::{code-examples}/test/autoconfigure/restdocs/webclient/MyWebTestClientBuilderCustomizerConfiguration.java[]
include::{code-examples}/test/autoconfigure/restdocs/webclient/ParameterizedOutputConfigurationExample.java[tag=configuration]
----