Merge pull request #15978 from nosan

* pr/15978:
  Polish contribution
  Add an example showing how to use Spring REST Docs with WebTestClient

Author: snicoll

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

@@ -7695,6 +7695,28 @@ generate the default snippets. The following example shows a
 
 
 
+[[boot-features-testing-spring-boot-applications-testing-autoconfigured-rest-docs-web-test-client]]
+===== Auto-configured Spring REST Docs Tests with WebTestClient
+`@AutoConfigureRestDocs` can also be used with `WebTestClient`. You can inject it by using
+`@Autowired` and use it in your tests as you normally would when using `@WebFluxTest` and
+Spring REST Docs, as shown in the following example:
+
+[source,java,indent=0]
+----
+include::{code-examples}/test/autoconfigure/restdocs/webclient/UsersDocumentationTests.java[tag=source]
+----
+
+If you require more control over Spring REST Docs configuration than offered by the
+attributes of `@AutoConfigureRestDocs`, you can use a
+`RestDocsWebTestClientConfigurationCustomizer` bean, as shown in the following example:
+
+[source,java,indent=0]
+----
+include::{code-examples}/test/autoconfigure/restdocs/webclient/AdvancedConfigurationExample.java[tag=configuration]
+----
+
+
+
 [[boot-features-testing-spring-boot-applications-testing-autoconfigured-rest-docs-rest-assured]]
 ===== Auto-configured Spring REST Docs Tests with REST Assured
 `@AutoConfigureRestDocs` makes a `RequestSpecification` bean, preconfigured to use Spring

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

@@ -0,0 +1,38 @@
+/*
+ * Copyright 2012-2019 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
+ *
+ *      http://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.autoconfigure.restdocs.RestDocsWebTestClientConfigurationCustomizer;
+import org.springframework.boot.test.context.TestConfiguration;
+import org.springframework.restdocs.webtestclient.WebTestClientRestDocumentationConfigurer;
+
+public class AdvancedConfigurationExample {
+
+	// tag::configuration[]
+	@TestConfiguration
+	public static class CustomizationConfiguration
+			implements RestDocsWebTestClientConfigurationCustomizer {
+
+		@Override
+		public void customize(WebTestClientRestDocumentationConfigurer configurer) {
+			configurer.snippets().withEncoding("UTF-8");
+		}
+
+	}
+	// end::configuration[]
+
+}

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

@@ -0,0 +1,46 @@
+/*
+ * Copyright 2012-2019 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
+ *
+ *      http://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;
+
+// tag::source[]
+import org.junit.jupiter.api.Test;
+import org.junit.runner.RunWith;
+
+import org.springframework.beans.factory.annotation.Autowired;
+import org.springframework.boot.test.autoconfigure.restdocs.AutoConfigureRestDocs;
+import org.springframework.boot.test.autoconfigure.web.reactive.WebFluxTest;
+import org.springframework.test.context.junit4.SpringRunner;
+import org.springframework.test.web.reactive.server.WebTestClient;
+
+import static org.springframework.restdocs.webtestclient.WebTestClientRestDocumentation.document;
+
+@RunWith(SpringRunner.class)
+@WebFluxTest
+@AutoConfigureRestDocs
+public class UsersDocumentationTests {
+
+	@Autowired
+	private WebTestClient webTestClient;
+
+	@Test
+	void listUsers() {
+		this.webTestClient.get().uri("/").exchange().expectStatus().isOk().expectBody()
+				.consumeWith(document("list-users"));
+	}
+
+}
+// end::source[]