Browse Source

Merge pull request #27755 from brneto

* gh-27755:
  Polish "Document how to parameterize REST Docs' output dir with WebTestClient"
  Document how to parameterize REST Docs' output dir with WebTestClient

Closes gh-27755
pull/28061/head
Andy Wilkinson 4 years ago
parent
commit
a8652a89b2
  1. 8
      spring-boot-project/spring-boot-docs/src/docs/asciidoc/spring-boot-features.adoc
  2. 39
      spring-boot-project/spring-boot-docs/src/main/java/org/springframework/boot/docs/test/autoconfigure/restdocs/webclient/ParameterizedOutputConfigurationExample.java

8
spring-boot-project/spring-boot-docs/src/docs/asciidoc/spring-boot-features.adoc

@ -8063,6 +8063,14 @@ If you require more control over Spring REST Docs configuration than offered by @@ -8063,6 +8063,14 @@ 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 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]
----
include::{code-examples}/test/autoconfigure/restdocs/webclient/ParameterizedOutputConfigurationExample.java[tag=configuration]
----
[[boot-features-testing-spring-boot-applications-testing-autoconfigured-rest-docs-rest-assured]]

39
spring-boot-project/spring-boot-docs/src/main/java/org/springframework/boot/docs/test/autoconfigure/restdocs/webclient/ParameterizedOutputConfigurationExample.java

@ -0,0 +1,39 @@ @@ -0,0 +1,39 @@
/*
* Copyright 2012-2021 the original author or authors.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* https://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package org.springframework.boot.docs.test.autoconfigure.restdocs.webclient;
import org.springframework.boot.test.context.TestConfiguration;
import org.springframework.boot.test.web.reactive.server.WebTestClientBuilderCustomizer;
import org.springframework.context.annotation.Bean;
import static org.springframework.restdocs.webtestclient.WebTestClientRestDocumentation.document;
class ParameterizedOutputConfigurationExample {
// tag::configuration[]
@TestConfiguration(proxyBeanMethods = false)
static class ParameterizedOutputConfiguration {
@Bean
WebTestClientBuilderCustomizer restDocumentation() {
return (builder) -> builder.entityExchangeResultConsumer(document("{method-name}"));
}
}
// end::configuration[]
}
Loading…
Cancel
Save