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

Document how to parameterize REST Docs' output dir with WebTestClient

Browse Source 
See gh-27755
This commit is contained in:
Berchris Requiao
2021-08-18 16:33:45 +01:00
committed by Andy Wilkinson
parent f8ef90813f
commit c83f6ebaa2
2 changed files with 43 additions and 0 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,6 +8063,16 @@ 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:
[source,java,indent=0,subs="verbatim"]
----
include::{code-examples}/test/autoconfigure/restdocs/webclient/MyWebTestClientBuilderCustomizerConfiguration.java[]
----
[[boot-features-testing-spring-boot-applications-testing-autoconfigured-rest-docs-rest-assured]]