Add support for using WebFlux's WebTestClient to document an API

Closes gh-384

docs/src/test/java/com/example/webtestclient/CustomDefaultOperationPreprocessors.java

@@ -0,0 +1,55 @@
+/*
+ * Copyright 2014-2017 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 com.example.webtestclient;
+
+import org.junit.Before;
+import org.junit.Rule;
+
+import org.springframework.restdocs.JUnitRestDocumentation;
+import org.springframework.test.web.reactive.server.WebTestClient;
+import org.springframework.web.context.WebApplicationContext;
+
+import static org.springframework.restdocs.operation.preprocess.Preprocessors.prettyPrint;
+import static org.springframework.restdocs.operation.preprocess.Preprocessors.removeHeaders;
+import static org.springframework.restdocs.webtestclient.WebTestClientRestDocumentation.documentationConfiguration;
+
+public class CustomDefaultOperationPreprocessors {
+
+	// @formatter:off
+
+	@Rule
+	public final JUnitRestDocumentation restDocumentation = new JUnitRestDocumentation();
+
+	private WebApplicationContext context;
+
+	@SuppressWarnings("unused")
+	private WebTestClient webTestClient;
+
+	@Before
+	public void setup() {
+		// tag::custom-default-operation-preprocessors[]
+		this.webTestClient = WebTestClient.bindToApplicationContext(this.context)
+			.configureClient()
+			.filter(documentationConfiguration(this.restDocumentation)
+				.operationPreprocessors()
+					.withRequestDefaults(removeHeaders("Foo")) // <1>
+					.withResponseDefaults(prettyPrint())) // <2>
+			.build();
+		// end::custom-default-operation-preprocessors[]
+	}
+
+}

docs/src/test/java/com/example/webtestclient/CustomDefaultSnippets.java

@@ -0,0 +1,54 @@
+/*
+ * Copyright 2014-2017 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 com.example.webtestclient;
+
+import org.junit.Before;
+import org.junit.Rule;
+
+import org.springframework.beans.factory.annotation.Autowired;
+import org.springframework.restdocs.JUnitRestDocumentation;
+import org.springframework.test.web.reactive.server.WebTestClient;
+import org.springframework.web.context.WebApplicationContext;
+
+import static org.springframework.restdocs.cli.CliDocumentation.curlRequest;
+import static org.springframework.restdocs.webtestclient.WebTestClientRestDocumentation.documentationConfiguration;
+
+public class CustomDefaultSnippets {
+
+	// @formatter:off
+
+	@Rule
+	public final JUnitRestDocumentation restDocumentation = new JUnitRestDocumentation();
+
+	@Autowired
+	private WebApplicationContext context;
+
+	@SuppressWarnings("unused")
+	private WebTestClient webTestClient;
+
+	@Before
+	public void setUp() {
+		// tag::custom-default-snippets[]
+		this.webTestClient = WebTestClient.bindToApplicationContext(this.context)
+			.configureClient().filter(
+				documentationConfiguration(this.restDocumentation)
+					.snippets().withDefaults(curlRequest()))
+			.build();
+		// end::custom-default-snippets[]
+	}
+
+}

docs/src/test/java/com/example/webtestclient/CustomEncoding.java

@@ -0,0 +1,52 @@
+/*
+ * Copyright 2014-2016 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 com.example.webtestclient;
+
+import org.junit.Before;
+import org.junit.Rule;
+
+import org.springframework.beans.factory.annotation.Autowired;
+import org.springframework.restdocs.JUnitRestDocumentation;
+import org.springframework.test.web.reactive.server.WebTestClient;
+import org.springframework.web.context.WebApplicationContext;
+
+import static org.springframework.restdocs.webtestclient.WebTestClientRestDocumentation.documentationConfiguration;
+
+public class CustomEncoding {
+
+	// @formatter:off
+
+	@Rule
+	public final JUnitRestDocumentation restDocumentation = new JUnitRestDocumentation();
+
+	@Autowired
+	private WebApplicationContext context;
+
+	@SuppressWarnings("unused")
+	private WebTestClient webTestClient;
+
+	@Before
+	public void setUp() {
+		// tag::custom-encoding[]
+		this.webTestClient = WebTestClient.bindToApplicationContext(this.context).configureClient()
+			.filter(documentationConfiguration(this.restDocumentation)
+				.snippets().withEncoding("ISO-8859-1"))
+			.build();
+		// end::custom-encoding[]
+	}
+
+}

docs/src/test/java/com/example/webtestclient/CustomFormat.java

@@ -0,0 +1,53 @@
+/*
+ * Copyright 2014-2016 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 com.example.webtestclient;
+
+import org.junit.Before;
+import org.junit.Rule;
+
+import org.springframework.beans.factory.annotation.Autowired;
+import org.springframework.restdocs.JUnitRestDocumentation;
+import org.springframework.restdocs.templates.TemplateFormats;
+import org.springframework.test.web.reactive.server.WebTestClient;
+import org.springframework.web.context.WebApplicationContext;
+
+import static org.springframework.restdocs.webtestclient.WebTestClientRestDocumentation.documentationConfiguration;
+
+public class CustomFormat {
+
+	// @formatter:off
+
+	@Rule
+	public final JUnitRestDocumentation restDocumentation = new JUnitRestDocumentation();
+
+	@Autowired
+	private WebApplicationContext context;
+
+	@SuppressWarnings("unused")
+	private WebTestClient webTestClient;
+
+	@Before
+	public void setUp() {
+		// tag::custom-format[]
+		this.webTestClient = WebTestClient.bindToApplicationContext(this.context).configureClient()
+			.filter(documentationConfiguration(this.restDocumentation)
+				.snippets().withTemplateFormat(TemplateFormats.markdown()))
+			.build();
+		// end::custom-format[]
+	}
+
+}

docs/src/test/java/com/example/webtestclient/CustomUriConfiguration.java

@@ -0,0 +1,52 @@
+/*
+ * Copyright 2014-2016 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 com.example.webtestclient;
+
+import org.junit.Before;
+import org.junit.Rule;
+import org.springframework.beans.factory.annotation.Autowired;
+import org.springframework.restdocs.JUnitRestDocumentation;
+import org.springframework.test.web.servlet.MockMvc;
+import org.springframework.test.web.servlet.setup.MockMvcBuilders;
+import org.springframework.web.context.WebApplicationContext;
+
+import static org.springframework.restdocs.mockmvc.MockMvcRestDocumentation.documentationConfiguration;
+
+public class CustomUriConfiguration {
+
+	@Rule
+	public final JUnitRestDocumentation restDocumentation = new JUnitRestDocumentation();
+
+	@Autowired
+	private WebApplicationContext context;
+
+	@SuppressWarnings("unused")
+	private MockMvc mockMvc;
+
+	@Before
+	public void setUp() {
+		// tag::custom-uri-configuration[]
+		this.mockMvc = MockMvcBuilders.webAppContextSetup(this.context)
+				.apply(documentationConfiguration(this.restDocumentation).uris()
+						.withScheme("https")
+						.withHost("example.com")
+						.withPort(443))
+				.build();
+		// end::custom-uri-configuration[]
+	}
+
+}

docs/src/test/java/com/example/webtestclient/EveryTestPreprocessing.java

@@ -0,0 +1,65 @@
+/*
+ * Copyright 2014-2016 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 com.example.webtestclient;
+
+import org.junit.Before;
+import org.junit.Rule;
+
+import org.springframework.restdocs.JUnitRestDocumentation;
+import org.springframework.test.web.reactive.server.WebTestClient;
+import org.springframework.web.context.WebApplicationContext;
+
+import static org.springframework.restdocs.hypermedia.HypermediaDocumentation.linkWithRel;
+import static org.springframework.restdocs.hypermedia.HypermediaDocumentation.links;
+import static org.springframework.restdocs.operation.preprocess.Preprocessors.prettyPrint;
+import static org.springframework.restdocs.operation.preprocess.Preprocessors.removeHeaders;
+import static org.springframework.restdocs.webtestclient.WebTestClientRestDocumentation.document;
+import static org.springframework.restdocs.webtestclient.WebTestClientRestDocumentation.documentationConfiguration;
+
+public class EveryTestPreprocessing {
+
+	// @formatter:off
+
+	@Rule
+	public final JUnitRestDocumentation restDocumentation = new JUnitRestDocumentation();
+
+	private WebApplicationContext context;
+
+	// tag::setup[]
+	private WebTestClient webTestClient;
+
+	@Before
+	public void setup() {
+		this.webTestClient = WebTestClient.bindToApplicationContext(this.context)
+			.configureClient()
+			.filter(documentationConfiguration(this.restDocumentation)
+				.operationPreprocessors()
+					.withRequestDefaults(removeHeaders("Foo")) // <1>
+					.withResponseDefaults(prettyPrint())) // <2>
+			.build();
+	}
+	// end::setup[]
+
+	public void use() throws Exception {
+		// tag::use[]
+		this.webTestClient.get().uri("/").exchange().expectStatus().isOk()
+			.expectBody().consumeWith(document("index",
+				links(linkWithRel("self").description("Canonical self link"))));
+		// end::use[]
+	}
+
+}

docs/src/test/java/com/example/webtestclient/ExampleApplicationJUnit5Tests.java

@@ -0,0 +1,46 @@
+/*
+ * Copyright 2014-2017 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 com.example.webtestclient;
+
+import org.junit.jupiter.api.BeforeEach;
+import org.junit.jupiter.api.extension.ExtendWith;
+
+import org.springframework.restdocs.RestDocumentationContextProvider;
+import org.springframework.restdocs.RestDocumentationExtension;
+import org.springframework.test.web.reactive.server.WebTestClient;
+import org.springframework.web.context.WebApplicationContext;
+
+import static org.springframework.restdocs.webtestclient.WebTestClientRestDocumentation.documentationConfiguration;
+
+@ExtendWith(RestDocumentationExtension.class)
+public class ExampleApplicationJUnit5Tests {
+
+	@SuppressWarnings("unused")
+	// tag::setup[]
+	private WebTestClient webTestClient;
+
+	@BeforeEach
+	public void setUp(WebApplicationContext webApplicationContext,
+			RestDocumentationContextProvider restDocumentation) {
+		this.webTestClient = WebTestClient.bindToApplicationContext(webApplicationContext)
+				.configureClient()
+				.filter(documentationConfiguration(restDocumentation)) // <1>
+				.build();
+	}
+	// end::setup[]
+
+}

docs/src/test/java/com/example/webtestclient/ExampleApplicationTestNgTests.java

@@ -0,0 +1,60 @@
+/*
+ * Copyright 2014-2017 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 com.example.webtestclient;
+
+import java.lang.reflect.Method;
+
+import org.testng.annotations.AfterMethod;
+import org.testng.annotations.BeforeMethod;
+
+import org.springframework.beans.factory.annotation.Autowired;
+import org.springframework.restdocs.ManualRestDocumentation;
+import org.springframework.test.web.reactive.server.WebTestClient;
+import org.springframework.web.context.WebApplicationContext;
+
+import static org.springframework.restdocs.webtestclient.WebTestClientRestDocumentation.documentationConfiguration;
+
+public class ExampleApplicationTestNgTests {
+
+	public final ManualRestDocumentation restDocumentation = new ManualRestDocumentation();
+
+	@SuppressWarnings("unused")
+	// tag::setup[]
+	private WebTestClient webTestClient;
+
+	@Autowired
+	private WebApplicationContext context;
+
+	@BeforeMethod
+	public void setUp(Method method) {
+		this.webTestClient = WebTestClient.bindToApplicationContext(this.context)
+				.configureClient()
+				.filter(documentationConfiguration(this.restDocumentation)) // <1>
+				.build();
+		this.restDocumentation.beforeTest(getClass(), method.getName());
+	}
+
+	// end::setup[]
+
+	// tag::teardown[]
+	@AfterMethod
+	public void tearDown() {
+		this.restDocumentation.afterTest();
+	}
+	// end::teardown[]
+
+}

docs/src/test/java/com/example/webtestclient/ExampleApplicationTests.java

@@ -0,0 +1,50 @@
+/*
+ * Copyright 2014-2017 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 com.example.webtestclient;
+
+import org.junit.Before;
+import org.junit.Rule;
+
+import org.springframework.beans.factory.annotation.Autowired;
+import org.springframework.restdocs.JUnitRestDocumentation;
+import org.springframework.test.web.reactive.server.WebTestClient;
+import org.springframework.web.context.WebApplicationContext;
+
+import static org.springframework.restdocs.webtestclient.WebTestClientRestDocumentation.documentationConfiguration;
+
+public class ExampleApplicationTests {
+
+	@Rule
+	public final JUnitRestDocumentation restDocumentation = new JUnitRestDocumentation();
+
+	@SuppressWarnings("unused")
+	// tag::setup[]
+	private WebTestClient webTestClient;
+
+	@Autowired
+	private WebApplicationContext context;
+
+	@Before
+	public void setUp() {
+		this.webTestClient = WebTestClient.bindToApplicationContext(this.context)
+				.configureClient()
+				.filter(documentationConfiguration(this.restDocumentation)) // <1>
+				.build();
+	}
+	// end::setup[]
+
+}

docs/src/test/java/com/example/webtestclient/HttpHeaders.java

@@ -0,0 +1,49 @@
+/*
+ * Copyright 2014-2017 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 com.example.webtestclient;
+
+import org.springframework.test.web.reactive.server.WebTestClient;
+
+import static org.springframework.restdocs.headers.HeaderDocumentation.headerWithName;
+import static org.springframework.restdocs.headers.HeaderDocumentation.requestHeaders;
+import static org.springframework.restdocs.headers.HeaderDocumentation.responseHeaders;
+import static org.springframework.restdocs.webtestclient.WebTestClientRestDocumentation.document;
+
+public class HttpHeaders {
+
+	// @formatter:off
+
+	private WebTestClient webTestClient;
+
+	public void headers() throws Exception {
+		// tag::headers[]
+		this.webTestClient
+			.get().uri("/people").header("Authorization", "Basic dXNlcjpzZWNyZXQ=") // <1>
+			.exchange().expectStatus().isOk().expectBody()
+			.consumeWith(document("headers",
+				requestHeaders( // <2>
+					headerWithName("Authorization").description("Basic auth credentials")), // <3>
+				responseHeaders( // <4>
+					headerWithName("X-RateLimit-Limit")
+						.description("The total number of requests permitted per period"),
+					headerWithName("X-RateLimit-Remaining")
+						.description("Remaining requests permitted in current period"),
+					headerWithName("X-RateLimit-Reset")
+						.description("Time at which the rate limit period will reset"))));
+		// end::headers[]
+	}
+}

docs/src/test/java/com/example/webtestclient/Hypermedia.java

@@ -0,0 +1,51 @@
+/*
+ * Copyright 2014-2017 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 com.example.webtestclient;
+
+import org.springframework.http.MediaType;
+import org.springframework.test.web.reactive.server.WebTestClient;
+
+import static org.springframework.restdocs.hypermedia.HypermediaDocumentation.halLinks;
+import static org.springframework.restdocs.hypermedia.HypermediaDocumentation.linkWithRel;
+import static org.springframework.restdocs.hypermedia.HypermediaDocumentation.links;
+import static org.springframework.restdocs.webtestclient.WebTestClientRestDocumentation.document;
+
+public class Hypermedia {
+
+	private WebTestClient webTestClient;
+
+	public void defaultExtractor() throws Exception {
+		// tag::links[]
+		this.webTestClient.get().uri("/").accept(MediaType.APPLICATION_JSON).exchange()
+			.expectStatus().isOk().expectBody()
+			.consumeWith(document("index",links( // <1>
+					linkWithRel("alpha").description("Link to the alpha resource"), // <2>
+					linkWithRel("bravo").description("Link to the bravo resource")))); // <3>
+		// end::links[]
+	}
+
+	public void explicitExtractor() throws Exception {
+		this.webTestClient.get().uri("/").accept(MediaType.APPLICATION_JSON).exchange()
+		.expectStatus().isOk().expectBody()
+		// tag::explicit-extractor[]
+		.consumeWith(document("index",links(halLinks(), // <1>
+				linkWithRel("alpha").description("Link to the alpha resource"),
+				linkWithRel("bravo").description("Link to the bravo resource"))));
+		// end::explicit-extractor[]
+	}
+
+}

docs/src/test/java/com/example/webtestclient/InvokeService.java

@@ -0,0 +1,36 @@
+/*
+ * Copyright 2014-2017 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 com.example.webtestclient;
+
+import org.springframework.http.MediaType;
+import org.springframework.test.web.reactive.server.WebTestClient;
+
+import static org.springframework.restdocs.webtestclient.WebTestClientRestDocumentation.document;
+
+public class InvokeService {
+
+	private WebTestClient webTestClient;
+
+	public void invokeService() throws Exception {
+		// tag::invoke-service[]
+		this.webTestClient.get().uri("/").accept(MediaType.APPLICATION_JSON) // <1>
+				.exchange().expectStatus().isOk() // <2>
+				.expectBody().consumeWith(document("index")); // <3>
+		// end::invoke-service[]
+	}
+
+}

docs/src/test/java/com/example/webtestclient/PathParameters.java

@@ -0,0 +1,42 @@
+/*
+ * Copyright 2014-2017 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 com.example.webtestclient;
+
+import org.springframework.test.web.reactive.server.WebTestClient;
+
+import static org.springframework.restdocs.request.RequestDocumentation.parameterWithName;
+import static org.springframework.restdocs.request.RequestDocumentation.pathParameters;
+import static org.springframework.restdocs.webtestclient.WebTestClientRestDocumentation.document;
+
+public class PathParameters {
+
+	// @formatter:off
+
+	private WebTestClient webTestClient;
+
+	public void pathParametersSnippet() throws Exception {
+		// tag::path-parameters[]
+		this.webTestClient.get().uri("/locations/{latitude}/{longitude}", 51.5072, 0.1275) // <1>
+			.exchange().expectStatus().isOk().expectBody()
+			.consumeWith(document("locations",
+				pathParameters( // <2>
+					parameterWithName("latitude").description("The location's latitude"), // <3>
+					parameterWithName("longitude").description("The location's longitude")))); // <4>
+		// end::path-parameters[]
+	}
+
+}

docs/src/test/java/com/example/webtestclient/Payload.java

@@ -0,0 +1,132 @@
+/*
+ * Copyright 2014-2017 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 com.example.webtestclient;
+
+import org.springframework.http.MediaType;
+import org.springframework.restdocs.payload.FieldDescriptor;
+import org.springframework.restdocs.payload.JsonFieldType;
+import org.springframework.test.web.reactive.server.WebTestClient;
+
+import static org.springframework.restdocs.payload.PayloadDocumentation.beneathPath;
+import static org.springframework.restdocs.payload.PayloadDocumentation.fieldWithPath;
+import static org.springframework.restdocs.payload.PayloadDocumentation.requestFields;
+import static org.springframework.restdocs.payload.PayloadDocumentation.responseBody;
+import static org.springframework.restdocs.payload.PayloadDocumentation.responseFields;
+import static org.springframework.restdocs.payload.PayloadDocumentation.subsectionWithPath;
+import static org.springframework.restdocs.snippet.Attributes.attributes;
+import static org.springframework.restdocs.snippet.Attributes.key;
+import static org.springframework.restdocs.webtestclient.WebTestClientRestDocumentation.document;
+
+public class Payload {
+
+	// @formatter:off
+
+	private WebTestClient webTestClient;
+
+	public void response() throws Exception {
+		// tag::response[]
+		this.webTestClient.get().uri("user/5").accept(MediaType.APPLICATION_JSON)
+			.exchange().expectStatus().isOk().expectBody()
+			.consumeWith(document("user",
+				responseFields( // <1>
+					fieldWithPath("contact.email").description("The user's email address"), // <2>
+					fieldWithPath("contact.name").description("The user's name")))); // <3>
+		// end::response[]
+	}
+
+	public void subsection() throws Exception {
+		// tag::subsection[]
+		this.webTestClient.get().uri("user/5").accept(MediaType.APPLICATION_JSON)
+			.exchange().expectStatus().isOk().expectBody()
+			.consumeWith(document("user",
+				responseFields(
+					subsectionWithPath("contact").description("The user's contact details")))); // <1>
+		// end::subsection[]
+	}
+
+	public void explicitType() throws Exception {
+		this.webTestClient.get().uri("user/5").accept(MediaType.APPLICATION_JSON)
+			.exchange().expectStatus().isOk().expectBody()
+			// tag::explicit-type[]
+			.consumeWith(document("user",
+				responseFields(
+					fieldWithPath("contact.email")
+						.type(JsonFieldType.STRING) // <1>
+						.description("The user's email address"))));
+		// end::explicit-type[]
+	}
+
+	public void constraints() throws Exception {
+		this.webTestClient.get().uri("user/5").accept(MediaType.APPLICATION_JSON)
+			.exchange().expectStatus().isOk().expectBody()
+			// tag::constraints[]
+			.consumeWith(document("create-user",
+				requestFields(
+					attributes(key("title").value("Fields for user creation")), // <1>
+					fieldWithPath("name")
+						.description("The user's name")
+						.attributes(key("constraints").value("Must not be null. Must not be empty")), // <2>
+					fieldWithPath("email")
+						.description("The user's email address")
+						.attributes(key("constraints").value("Must be a valid email address"))))); // <3>
+			// end::constraints[]
+	}
+
+	public void descriptorReuse() throws Exception {
+		FieldDescriptor[] book = new FieldDescriptor[] {
+				fieldWithPath("title").description("Title of the book"),
+				fieldWithPath("author").description("Author of the book") };
+
+		// tag::single-book[]
+		this.webTestClient.get().uri("/books/1").accept(MediaType.APPLICATION_JSON)
+			.exchange().expectStatus().isOk().expectBody()
+			.consumeWith(document("book",
+				responseFields(book))); // <1>
+		// end::single-book[]
+
+		// tag::book-array[]
+		this.webTestClient.get().uri("/books").accept(MediaType.APPLICATION_JSON)
+			.exchange().expectStatus().isOk().expectBody()
+			.consumeWith(document("books",
+				responseFields(
+					fieldWithPath("[]")
+						.description("An array of books")) // <1>
+						.andWithPrefix("[].", book))); // <2>
+		// end::book-array[]
+	}
+
+	public void fieldsSubsection() throws Exception {
+		// tag::fields-subsection[]
+		this.webTestClient.get().uri("/locations/1").accept(MediaType.APPLICATION_JSON)
+			.exchange().expectStatus().isOk().expectBody()
+			.consumeWith(document("temperature",
+				responseFields(beneathPath("weather.temperature"), // <1>
+					fieldWithPath("high").description("The forecast high in degrees celcius"), // <2>
+					fieldWithPath("low").description("The forecast low in degrees celcius"))));
+		// end::fields-subsection[]
+	}
+
+	public void bodySubsection() throws Exception {
+		// tag::body-subsection[]
+		this.webTestClient.get().uri("/locations/1").accept(MediaType.APPLICATION_JSON)
+			.exchange().expectStatus().isOk().expectBody()
+			.consumeWith(document("temperature",
+				responseBody(beneathPath("weather.temperature")))); // <1>
+		// end::body-subsection[]
+	}
+
+}

docs/src/test/java/com/example/webtestclient/PerTestPreprocessing.java

@@ -0,0 +1,42 @@
+/*
+ * Copyright 2014-2017 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 com.example.webtestclient;
+
+import org.springframework.test.web.reactive.server.WebTestClient;
+
+import static org.springframework.restdocs.operation.preprocess.Preprocessors.preprocessRequest;
+import static org.springframework.restdocs.operation.preprocess.Preprocessors.preprocessResponse;
+import static org.springframework.restdocs.operation.preprocess.Preprocessors.prettyPrint;
+import static org.springframework.restdocs.operation.preprocess.Preprocessors.removeHeaders;
+import static org.springframework.restdocs.webtestclient.WebTestClientRestDocumentation.document;
+
+public class PerTestPreprocessing {
+
+	// @formatter:off
+
+	private WebTestClient webTestClient;
+
+	public void general() {
+		// tag::preprocessing[]
+		this.webTestClient.get().uri("/").exchange().expectStatus().isOk().expectBody()
+			.consumeWith(document("index",
+				preprocessRequest(removeHeaders("Foo")), // <1>
+				preprocessResponse(prettyPrint()))); // <2>
+		// end::preprocessing[]
+	}
+
+}

docs/src/test/java/com/example/webtestclient/RequestParameters.java

@@ -0,0 +1,57 @@
+/*
+ * Copyright 2014-2017 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 com.example.webtestclient;
+
+import org.springframework.test.web.reactive.server.WebTestClient;
+import org.springframework.util.LinkedMultiValueMap;
+import org.springframework.util.MultiValueMap;
+import org.springframework.web.reactive.function.BodyInserters;
+
+import static org.springframework.restdocs.request.RequestDocumentation.parameterWithName;
+import static org.springframework.restdocs.request.RequestDocumentation.requestParameters;
+import static org.springframework.restdocs.webtestclient.WebTestClientRestDocumentation.document;
+
+public class RequestParameters {
+
+	// @formatter:off
+
+	private WebTestClient webTestClient;
+
+	public void getQueryStringSnippet() throws Exception {
+		// tag::request-parameters-query-string[]
+		this.webTestClient.get().uri("/users?page=2&per_page=100") // <1>
+			.exchange().expectStatus().isOk().expectBody()
+			.consumeWith(document("users", requestParameters( // <2>
+					parameterWithName("page").description("The page to retrieve"), // <3>
+					parameterWithName("per_page").description("Entries per page") // <4>
+			)));
+		// end::request-parameters-query-string[]
+	}
+
+	public void postFormDataSnippet() throws Exception {
+		// tag::request-parameters-form-data[]
+		MultiValueMap<String, String> formData = new LinkedMultiValueMap<>();
+		formData.add("username", "Tester");
+		this.webTestClient.post().uri("/users").body(BodyInserters.fromFormData(formData)) // <1>
+			.exchange().expectStatus().isCreated().expectBody()
+			.consumeWith(document("create-user", requestParameters(
+				parameterWithName("username").description("The user's username")
+		)));
+		// end::request-parameters-form-data[]
+	}
+
+}

docs/src/test/java/com/example/webtestclient/RequestPartPayload.java

@@ -0,0 +1,83 @@
+/*
+ * Copyright 2014-2017 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 com.example.webtestclient;
+
+import java.util.Collections;
+
+import org.springframework.core.io.ByteArrayResource;
+import org.springframework.core.io.Resource;
+import org.springframework.http.MediaType;
+import org.springframework.test.web.reactive.server.WebTestClient;
+import org.springframework.util.LinkedMultiValueMap;
+import org.springframework.util.MultiValueMap;
+
+import static org.springframework.restdocs.payload.PayloadDocumentation.fieldWithPath;
+import static org.springframework.restdocs.payload.PayloadDocumentation.requestPartBody;
+import static org.springframework.restdocs.payload.PayloadDocumentation.requestPartFields;
+import static org.springframework.restdocs.webtestclient.WebTestClientRestDocumentation.document;
+
+public class RequestPartPayload {
+
+	// @formatter:off
+
+	private WebTestClient webTestClient;
+
+	public void fields() throws Exception {
+		// tag::fields[]
+		MultiValueMap<String, Object> multipartData = new LinkedMultiValueMap<>();
+		Resource imageResource = new ByteArrayResource("<<png data>>".getBytes()) {
+
+			@Override
+			public String getFilename() {
+				return "image.png";
+			}
+
+		};
+		multipartData.add("image", imageResource);
+		multipartData.add("metadata", Collections.singletonMap("version",  "1.0"));
+		this.webTestClient.post().uri("/images").syncBody(multipartData)
+			.accept(MediaType.APPLICATION_JSON).exchange()
+			.expectStatus().isOk().expectBody()
+			.consumeWith(document("image-upload",
+				requestPartFields("metadata", // <1>
+					fieldWithPath("version").description("The version of the image")))); // <2>
+		// end::fields[]
+	}
+
+	public void body() throws Exception {
+		// tag::body[]
+		MultiValueMap<String, Object> multipartData = new LinkedMultiValueMap<>();
+		Resource imageResource = new ByteArrayResource("<<png data>>".getBytes()) {
+
+			@Override
+			public String getFilename() {
+				return "image.png";
+			}
+
+		};
+		multipartData.add("image", imageResource);
+		multipartData.add("metadata", Collections.singletonMap("version",  "1.0"));
+
+		this.webTestClient.post().uri("/images").syncBody(multipartData)
+			.accept(MediaType.APPLICATION_JSON).exchange()
+			.expectStatus().isOk().expectBody()
+			.consumeWith(document("image-upload",
+					requestPartBody("metadata"))); // <1>
+		// end::body[]
+	}
+
+}

docs/src/test/java/com/example/webtestclient/RequestParts.java

@@ -0,0 +1,45 @@
+/*
+ * Copyright 2014-2017 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 com.example.webtestclient;
+
+import org.springframework.test.web.reactive.server.WebTestClient;
+import org.springframework.util.LinkedMultiValueMap;
+import org.springframework.util.MultiValueMap;
+
+import static org.springframework.restdocs.request.RequestDocumentation.partWithName;
+import static org.springframework.restdocs.request.RequestDocumentation.requestParts;
+import static org.springframework.restdocs.webtestclient.WebTestClientRestDocumentation.document;
+
+public class RequestParts {
+
+	// @formatter:off
+
+	private WebTestClient webTestClient;
+
+	public void upload() throws Exception {
+		// tag::request-parts[]
+		MultiValueMap<String, Object> multipartData = new LinkedMultiValueMap<>();
+		multipartData.add("file", "example".getBytes());
+		this.webTestClient.post().uri("/upload").syncBody(multipartData) // <1>
+			.exchange().expectStatus().isOk().expectBody()
+			.consumeWith(document("upload", requestParts( // <2>
+				partWithName("file").description("The file to upload")) // <3>
+		));
+		// end::request-parts[]
+	}
+
+}

docs/src/test/java/com/example/webtestclient/WebTestClientSnippetReuse.java

@@ -0,0 +1,43 @@
+/*
+ * Copyright 2014-2017 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 com.example.webtestclient;
+
+import com.example.SnippetReuse;
+
+import org.springframework.http.MediaType;
+import org.springframework.test.web.reactive.server.WebTestClient;
+
+import static org.springframework.restdocs.hypermedia.HypermediaDocumentation.linkWithRel;
+import static org.springframework.restdocs.webtestclient.WebTestClientRestDocumentation.document;
+
+public class WebTestClientSnippetReuse extends SnippetReuse {
+
+	// @formatter:off
+
+	private WebTestClient webTestClient;
+
+	public void documentation() throws Exception {
+		// tag::use[]
+		this.webTestClient.get().uri("/").accept(MediaType.APPLICATION_JSON).exchange()
+			.expectStatus().isOk().expectBody()
+			.consumeWith(document("example", this.pagingLinks.and( // <1>
+				linkWithRel("alpha").description("Link to the alpha resource"),
+				linkWithRel("bravo").description("Link to the bravo resource"))));
+		// end::use[]
+	}
+
+}