Move client and testing docs to compiled code snippets

Prior to this commit, the "client" and "testing" sections of the
reference documentation were using inline code snippets.
Because of this, several snippets were out of date or invalid.

This commit moves all those code snippets to actual Java classes
compiled with the documentation.

Fixes gh-1042

spring-graphql-docs/src/main/java/org/springframework/graphql/docs/client/httpgraphqlclient/ClientUsage.java

@@ -0,0 +1,48 @@
+/*
+ * Copyright 2020-2024 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.graphql.docs.client.httpgraphqlclient;
+
+import org.springframework.graphql.client.HttpGraphQlClient;
+import org.springframework.web.reactive.function.client.WebClient;
+
+public class ClientUsage {
+
+	void create() {
+		// tag::create[]
+		WebClient webClient = WebClient.create("https://spring.io/graphql");
+		HttpGraphQlClient graphQlClient = HttpGraphQlClient.create(webClient);
+		// end::create[]
+	}
+
+	void mutateClient() {
+		// tag::mutate[]
+		WebClient webClient = WebClient.create("https://spring.io/graphql");
+
+		HttpGraphQlClient graphQlClient = HttpGraphQlClient.builder(webClient)
+				.headers((headers) -> headers.setBasicAuth("joe", "..."))
+				.build();
+
+		// Perform requests with graphQlClient...
+
+		HttpGraphQlClient anotherGraphQlClient = graphQlClient.mutate()
+				.headers((headers) -> headers.setBasicAuth("peter", "..."))
+				.build();
+
+		// Perform requests with anotherGraphQlClient...
+		// end::mutate[]
+	}
+}

spring-graphql-docs/src/main/java/org/springframework/graphql/docs/client/httpsyncgraphqlclient/SyncClientUsage.java

@@ -0,0 +1,48 @@
+/*
+ * Copyright 2020-2024 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.graphql.docs.client.httpsyncgraphqlclient;
+
+import org.springframework.graphql.client.HttpSyncGraphQlClient;
+import org.springframework.web.client.RestClient;
+
+public class SyncClientUsage {
+
+	void createClient() {
+		// tag::create[]
+		RestClient restClient = RestClient.create("https://spring.io/graphql");
+		HttpSyncGraphQlClient graphQlClient = HttpSyncGraphQlClient.create(restClient);
+		// end::create[]
+	}
+
+	void mutateClient() {
+		// tag::mutate[]
+		RestClient restClient = RestClient.create("https://spring.io/graphql");
+		HttpSyncGraphQlClient graphQlClient = HttpSyncGraphQlClient.builder(restClient)
+				.headers((headers) -> headers.setBasicAuth("joe", "..."))
+				.build();
+
+		// Perform requests with graphQlClient...
+
+		HttpSyncGraphQlClient anotherGraphQlClient = graphQlClient.mutate()
+				.headers((headers) -> headers.setBasicAuth("peter", "..."))
+				.build();
+
+		// Perform requests with anotherGraphQlClient...
+
+		// end::mutate[]
+	}
+}

spring-graphql-docs/src/main/java/org/springframework/graphql/docs/client/interception/MyInterceptor.java

@@ -0,0 +1,40 @@
+/*
+ * Copyright 2020-2024 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.graphql.docs.client.interception;
+
+import reactor.core.publisher.Flux;
+import reactor.core.publisher.Mono;
+
+import org.springframework.graphql.client.ClientGraphQlRequest;
+import org.springframework.graphql.client.ClientGraphQlResponse;
+import org.springframework.graphql.client.GraphQlClientInterceptor;
+
+public class MyInterceptor implements GraphQlClientInterceptor {
+
+	@Override
+	public Mono<ClientGraphQlResponse> intercept(ClientGraphQlRequest request, Chain chain) {
+		// ...
+		return chain.next(request);
+	}
+
+	@Override
+	public Flux<ClientGraphQlResponse> interceptSubscription(ClientGraphQlRequest request, SubscriptionChain chain) {
+		// ...
+		return chain.next(request);
+	}
+
+}

spring-graphql-docs/src/main/java/org/springframework/graphql/docs/client/interception/SyncInterceptor.java

@@ -0,0 +1,30 @@
+/*
+ * Copyright 2020-2024 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.graphql.docs.client.interception;
+
+import org.springframework.graphql.client.ClientGraphQlRequest;
+import org.springframework.graphql.client.ClientGraphQlResponse;
+import org.springframework.graphql.client.SyncGraphQlClientInterceptor;
+
+public class SyncInterceptor implements SyncGraphQlClientInterceptor {
+
+	@Override
+	public ClientGraphQlResponse intercept(ClientGraphQlRequest request, Chain chain) {
+		// ...
+		return chain.next(request);
+	}
+}

spring-graphql-docs/src/main/java/org/springframework/graphql/docs/client/interception/UseInterceptor.java

@@ -0,0 +1,37 @@
+/*
+ * Copyright 2020-2024 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.graphql.docs.client.interception;
+
+import java.net.URI;
+
+import org.springframework.graphql.client.WebSocketGraphQlClient;
+import org.springframework.web.reactive.socket.client.ReactorNettyWebSocketClient;
+import org.springframework.web.reactive.socket.client.WebSocketClient;
+
+public class UseInterceptor {
+
+	void registerInterceptor() {
+		// tag::register[]
+		URI url = URI.create("wss://localhost:8080/graphql");
+		WebSocketClient client = new ReactorNettyWebSocketClient();
+
+		WebSocketGraphQlClient graphQlClient = WebSocketGraphQlClient.builder(url, client)
+				.interceptor(new MyInterceptor())
+				.build();
+		// end::register[]
+	}
+}

spring-graphql-docs/src/main/java/org/springframework/graphql/docs/client/requests/documentsource/DocumentSource.java

@@ -0,0 +1,36 @@
+/*
+ * Copyright 2020-2024 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.graphql.docs.client.requests.documentsource;
+
+import org.springframework.graphql.client.GraphQlClient;
+
+public class DocumentSource {
+
+	void documentSource() {
+		GraphQlClient graphQlClient = null;
+		// tag::documentSource[]
+		Project project = graphQlClient.documentName("projectReleases") // <1>
+				.variable("slug", "spring-framework") // <2>
+				.retrieveSync("projectReleases.project")
+				.toEntity(Project.class);
+		// end::documentSource[]
+	}
+
+	record Project() {
+
+	}
+}

spring-graphql-docs/src/main/java/org/springframework/graphql/docs/client/requests/execute/Execute.java

@@ -0,0 +1,80 @@
+/*
+ * Copyright 2020-2024 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.graphql.docs.client.requests.execute;
+
+import reactor.core.publisher.Mono;
+
+import org.springframework.graphql.client.ClientGraphQlResponse;
+import org.springframework.graphql.client.ClientResponseField;
+import org.springframework.graphql.client.GraphQlClient;
+
+public class Execute {
+
+	void executeSync() {
+		GraphQlClient graphQlClient = null;
+		String document = "";
+		// tag::executeSync[]
+		ClientGraphQlResponse response = graphQlClient.document(document).executeSync();
+
+		if (!response.isValid()) {
+			// Request failure... <1>
+		}
+
+		ClientResponseField field = response.field("project");
+		if (field.getValue() == null) {
+			if (field.getErrors().isEmpty()) {
+				// Optional field set to null... <2>
+			}
+			else {
+				// Field failure... <3>
+			}
+		}
+
+		Project project = field.toEntity(Project.class); // <4>
+		// end::executeSync[]
+	}
+
+	void execute() {
+		GraphQlClient graphQlClient = null;
+		String document = "";
+		// tag::execute[]
+		Mono<Project> projectMono = graphQlClient.document(document)
+				.execute()
+				.map((response) -> {
+					if (!response.isValid()) {
+						// Request failure... <1>
+					}
+
+					ClientResponseField field = response.field("project");
+					if (field.getValue() == null) {
+						if (field.getErrors().isEmpty()) {
+							// Optional field set to null... <2>
+						}
+						else {
+							// Field failure... <3>
+						}
+					}
+
+					return field.toEntity(Project.class); // <4>
+				});
+		// end::execute[]
+	}
+
+	record Project() {
+
+	}
+}

spring-graphql-docs/src/main/java/org/springframework/graphql/docs/client/requests/retrieve/Retrieve.java

@@ -0,0 +1,114 @@
+/*
+ * Copyright 2020-2024 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.graphql.docs.client.requests.retrieve;
+
+import reactor.core.publisher.Mono;
+
+import org.springframework.graphql.client.ClientGraphQlResponse;
+import org.springframework.graphql.client.ClientResponseField;
+import org.springframework.graphql.client.FieldAccessException;
+import org.springframework.graphql.client.GraphQlClient;
+
+public class Retrieve {
+
+	void retrieveSync() {
+		GraphQlClient graphQlClient = null;
+
+		// tag::retrieveSync[]
+		String document =
+			"""
+			{
+				project(slug:"spring-framework") {
+					name
+					releases {
+						version
+					}
+				}
+			}
+			""";
+
+		Project project = graphQlClient.document(document) // <1>
+			.retrieveSync("project") // <2>
+			.toEntity(Project.class); // <3>
+		// end::retrieveSync[]
+	}
+
+	void retrieve() {
+		GraphQlClient graphQlClient = null;
+
+		// tag::retrieve[]
+		String document =
+			"""
+			{
+				project(slug:"spring-framework") {
+					name
+					releases {
+						version
+					}
+				}
+			}
+			""";
+
+		Mono<Project> project = graphQlClient.document(document) // <1>
+				.retrieve("project") // <2>
+				.toEntity(Project.class); // <3>
+		// end::retrieve[]
+	}
+
+	Project fieldErrorSync() {
+		GraphQlClient graphQlClient = null;
+		String document = "";
+
+		// tag::fieldErrorSync[]
+		try {
+			Project project = graphQlClient.document(document)
+					.retrieveSync("project")
+					.toEntity(Project.class);
+			return project;
+		}
+		catch (FieldAccessException ex) {
+			ClientGraphQlResponse response = ex.getResponse();
+			// ...
+			ClientResponseField field = ex.getField();
+			// return fallback value
+			return new Project();
+		}
+		// end::fieldErrorSync[]
+	}
+
+	void fieldError() {
+		GraphQlClient graphQlClient = null;
+		String document = "";
+
+		// tag::fieldError[]
+		Mono<Project> projectMono = graphQlClient.document(document)
+				.retrieve("project")
+				.toEntity(Project.class)
+				.onErrorResume(FieldAccessException.class, (ex) -> {
+					ClientGraphQlResponse response = ex.getResponse();
+					// ...
+					ClientResponseField field = ex.getField();
+					// return fallback value
+					return Mono.just(new Project());
+				});
+		// end::fieldError[]
+	}
+
+	record Project() {
+
+	}
+}

spring-graphql-docs/src/main/java/org/springframework/graphql/docs/client/rsocketgraphqlclient/RSocketClientUsage.java

@@ -0,0 +1,37 @@
+/*
+ * Copyright 2020-2024 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.graphql.docs.client.rsocketgraphqlclient;
+
+import java.net.URI;
+
+import io.rsocket.transport.netty.client.WebsocketClientTransport;
+
+import org.springframework.graphql.client.RSocketGraphQlClient;
+
+public class RSocketClientUsage {
+
+	void create() {
+		// tag::create[]
+		URI uri = URI.create("wss://localhost:8080/rsocket");
+		WebsocketClientTransport transport = WebsocketClientTransport.create(uri);
+
+		RSocketGraphQlClient client = RSocketGraphQlClient.builder()
+				.clientTransport(transport)
+				.build();
+		// end::create[]
+	}
+}

spring-graphql-docs/src/main/java/org/springframework/graphql/docs/client/subscriptions/execute/ExecuteSubscription.java

@@ -0,0 +1,50 @@
+/*
+ * Copyright 2020-2024 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.graphql.docs.client.subscriptions.execute;
+
+import reactor.core.publisher.Flux;
+
+import org.springframework.graphql.client.ClientResponseField;
+import org.springframework.graphql.client.GraphQlClient;
+
+public class ExecuteSubscription {
+
+	void subscriptionExecute() {
+		GraphQlClient client = null;
+		// tag::subscriptionExecute[]
+		Flux<String> greetingFlux = client.document("subscription { greetings }")
+				.executeSubscription()
+				.map((response) -> {
+					if (!response.isValid()) {
+						// Request failure...
+					}
+
+					ClientResponseField field = response.field("project");
+					if (field.getValue() == null) {
+						if (field.getErrors().isEmpty()) {
+							// Optional field set to null...
+						}
+						else {
+							// Field failure...
+						}
+					}
+
+					return field.toEntity(String.class);
+				});
+		// end::subscriptionExecute[]
+	}
+}

spring-graphql-docs/src/main/java/org/springframework/graphql/docs/client/subscriptions/retrieve/RetrieveSubscription.java

@@ -0,0 +1,33 @@
+/*
+ * Copyright 2020-2024 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.graphql.docs.client.subscriptions.retrieve;
+
+import reactor.core.publisher.Flux;
+
+import org.springframework.graphql.client.GraphQlClient;
+
+public class RetrieveSubscription {
+
+	void subscriptionRetrieve() {
+		GraphQlClient client = null;
+		// tag::subscriptionRetrieve[]
+		Flux<String> greetingFlux = client.document("subscription { greetings }")
+				.retrieveSubscription("greeting")
+				.toEntity(String.class);
+		// end::subscriptionRetrieve[]
+	}
+}

spring-graphql-docs/src/main/java/org/springframework/graphql/docs/client/websocketgraphqlclient/WebSocketClientUsage.java

@@ -0,0 +1,67 @@
+/*
+ * Copyright 2020-2024 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.graphql.docs.client.websocketgraphqlclient;
+
+import java.time.Duration;
+
+import org.springframework.graphql.client.WebSocketGraphQlClient;
+import org.springframework.web.reactive.socket.client.ReactorNettyWebSocketClient;
+import org.springframework.web.reactive.socket.client.WebSocketClient;
+
+public class WebSocketClientUsage {
+
+	void create() {
+		// tag::create[]
+		String url = "wss://spring.io/graphql";
+		WebSocketClient client = new ReactorNettyWebSocketClient();
+
+		WebSocketGraphQlClient graphQlClient = WebSocketGraphQlClient.builder(url, client).build();
+		// end::create[]
+	}
+
+	void mutate() {
+		// tag::mutate[]
+		String url = "wss://spring.io/graphql";
+		WebSocketClient client = new ReactorNettyWebSocketClient();
+
+		WebSocketGraphQlClient graphQlClient = WebSocketGraphQlClient.builder(url, client)
+				.headers((headers) -> headers.setBasicAuth("joe", "..."))
+				.build();
+
+		// Use graphQlClient...
+
+		WebSocketGraphQlClient anotherGraphQlClient = graphQlClient.mutate()
+				.headers((headers) -> headers.setBasicAuth("peter", "..."))
+				.build();
+
+		// Use anotherGraphQlClient...
+
+		// end::mutate[]
+	}
+
+	void keepAlive() {
+		// tag::keepAlive[]
+		String url = "wss://spring.io/graphql";
+		WebSocketClient client = new ReactorNettyWebSocketClient();
+
+		WebSocketGraphQlClient graphQlClient = WebSocketGraphQlClient.builder(url, client)
+				.keepAlive(Duration.ofSeconds(30))
+				.build();
+		// end::keepAlive[]
+	}
+
+}

spring-graphql-docs/src/main/java/org/springframework/graphql/docs/testing/errors/TestErrors.java

@@ -0,0 +1,79 @@
+/*
+ * Copyright 2020-2024 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.graphql.docs.testing.errors;
+
+import org.springframework.graphql.server.WebGraphQlHandler;
+import org.springframework.graphql.test.tester.GraphQlTester;
+import org.springframework.graphql.test.tester.WebGraphQlTester;
+
+import static org.assertj.core.api.Assertions.assertThat;
+
+public class TestErrors {
+
+	void verifyErrors() {
+		GraphQlTester graphQlTester = null;
+		String query = "";
+		// tag::verifyErrors[]
+		graphQlTester.document(query)
+				.execute()
+				.errors()
+				.filter((error) -> error.getMessage().equals("ignored error"))
+				.verify()
+				.path("project.releases[*].version")
+				.entityList(String.class)
+				.hasSizeGreaterThan(1);
+		// end::verifyErrors[]
+	}
+
+	void setupErrorFilter() {
+		WebGraphQlHandler handler = null;
+		// tag::setupErrorFilter[]
+		WebGraphQlTester graphQlTester = WebGraphQlTester.builder(handler)
+				.errorFilter((error) -> error.getMessage().equals("ignored error"))
+				.build();
+		// end::setupErrorFilter[]
+	}
+
+	void expectedErrors() {
+		GraphQlTester graphQlTester = null;
+		String query = "";
+		// tag::expectedErrors[]
+		graphQlTester.document(query)
+				.execute()
+				.errors()
+				.expect((error) -> error.getMessage().equals("expected error"))
+				.verify()
+				.path("project.releases[*].version")
+				.entityList(String.class)
+				.hasSizeGreaterThan(1);
+		// end::expectedErrors[]
+	}
+
+	void satisfyErrors() {
+		GraphQlTester graphQlTester = null;
+		String document = "";
+		// tag::satisfyErrors[]
+		graphQlTester.document(document)
+				.execute()
+				.errors()
+				.satisfy((errors) ->
+						assertThat(errors)
+								.anyMatch((error) -> error.getMessage().contains("ignored error"))
+				);
+		// end::satisfyErrors[]
+	}
+}

spring-graphql-docs/src/main/java/org/springframework/graphql/docs/testing/graphqlservicetester/ServiceSetup.java

@@ -0,0 +1,42 @@
+/*
+ * Copyright 2020-2024 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.graphql.docs.testing.graphqlservicetester;
+
+import graphql.execution.ExecutionId;
+
+import org.springframework.graphql.ExecutionGraphQlService;
+import org.springframework.graphql.test.tester.ExecutionGraphQlServiceTester;
+
+public class ServiceSetup {
+
+	void serviceSetup() {
+		// tag::serviceSetup[]
+		ExecutionGraphQlService service = /**/ null;
+		ExecutionGraphQlServiceTester tester = ExecutionGraphQlServiceTester.create(service);
+		// end::serviceSetup[]
+	}
+
+	void customServiceSetup() {
+		// tag::customServiceSetup[]
+		ExecutionGraphQlService service = /**/ null;
+		ExecutionId executionId = ExecutionId.generate();
+		ExecutionGraphQlServiceTester tester = ExecutionGraphQlServiceTester.builder(service)
+				.configureExecutionInput((executionInput, builder) -> builder.executionId(executionId).build())
+				.build();
+		// end::customServiceSetup[]
+	}
+}

spring-graphql-docs/src/main/java/org/springframework/graphql/docs/testing/httpgraphqltester/HttpSetup.java

@@ -0,0 +1,88 @@
+/*
+ * Copyright 2020-2024 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.graphql.docs.testing.httpgraphqltester;
+
+import org.springframework.graphql.test.tester.HttpGraphQlTester;
+import org.springframework.test.web.reactive.server.WebTestClient;
+import org.springframework.test.web.servlet.client.MockMvcWebTestClient;
+import org.springframework.web.context.support.AnnotationConfigWebApplicationContext;
+
+public class HttpSetup {
+
+	void webTestClient() {
+		// tag::webTestClient[]
+		AnnotationConfigWebApplicationContext context = /**/ new AnnotationConfigWebApplicationContext();
+
+		WebTestClient client =
+				WebTestClient.bindToApplicationContext(context)
+						.configureClient()
+						.baseUrl("/graphql")
+						.build();
+
+		HttpGraphQlTester tester = HttpGraphQlTester.create(client);
+		// end::webTestClient[]
+	}
+
+	void mockMvc() {
+		// tag::mockMvc[]
+		AnnotationConfigWebApplicationContext context = /**/ new AnnotationConfigWebApplicationContext();
+
+		WebTestClient client =
+				MockMvcWebTestClient.bindToApplicationContext(context)
+						.configureClient()
+						.baseUrl("/graphql")
+						.build();
+
+		HttpGraphQlTester tester = HttpGraphQlTester.create(client);
+		// end::mockMvc[]
+	}
+
+	void liveServer() {
+		// tag::liveServer[]
+		WebTestClient client =
+				WebTestClient.bindToServer()
+						.baseUrl("http://localhost:8080/graphql")
+						.build();
+
+		HttpGraphQlTester tester = HttpGraphQlTester.create(client);
+		// end::liveServer[]
+	}
+
+	void executeRequests() {
+		// tag::executeRequests[]
+		WebTestClient.Builder clientBuilder =
+				WebTestClient.bindToServer()
+						.baseUrl("http://localhost:8080/graphql");
+
+		HttpGraphQlTester tester = HttpGraphQlTester.builder(clientBuilder)
+				.headers((headers) -> headers.setBasicAuth("joe", "..."))
+				.build();
+
+		// Use tester...
+
+		HttpGraphQlTester anotherTester = tester.mutate()
+				.headers((headers) -> headers.setBasicAuth("peter", "..."))
+				.build();
+
+		// Use anotherTester...
+		// end::executeRequests[]
+	}
+
+	static class Configuration {
+
+	}
+}

spring-graphql-docs/src/main/java/org/springframework/graphql/docs/testing/requests/TesterRequests.java

@@ -0,0 +1,72 @@
+/*
+ * Copyright 2020-2024 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.graphql.docs.testing.requests;
+
+import org.springframework.graphql.test.tester.GraphQlTester;
+
+public class TesterRequests {
+
+	void inlineDocument() {
+		GraphQlTester graphQlTester = null;
+		// tag::inlineDocument[]
+		String document =
+				"""
+				{
+					project(slug:"spring-framework") {
+						releases {
+						version
+						}
+					}
+				}
+				""";
+
+		graphQlTester.document(document)
+				.execute()
+				.path("project.releases[*].version")
+				.entityList(String.class)
+				.hasSizeGreaterThan(1);
+		// end::inlineDocument[]
+	}
+
+	void documentName() {
+		GraphQlTester graphQlTester = null;
+		// tag::documentName[]
+		graphQlTester.documentName("projectReleases") // <1>
+				.variable("slug", "spring-framework") // <2>
+				.execute()
+				.path("projectReleases.project.releases[*].version")
+				.entityList(String.class)
+				.hasSizeGreaterThan(1);
+		// end::documentName[]
+	}
+
+	void fragment() {
+		GraphQlTester graphQlTester = null;
+		// tag::fragment[]
+		graphQlTester.documentName("projectReleases") // <1>
+				.fragmentName("releases") // <2>
+				.execute()
+				.path("frameworkReleases.project.releases[*].version")
+				.entityList(String.class)
+				.hasSizeGreaterThan(1);
+		// end::fragment[]
+	}
+
+	record Project() {
+
+	}
+}

spring-graphql-docs/src/main/java/org/springframework/graphql/docs/testing/requests/nestedpaths/NestedPaths.java

@@ -0,0 +1,34 @@
+/*
+ * Copyright 2020-2024 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.graphql.docs.testing.requests.nestedpaths;
+
+import org.springframework.graphql.test.tester.GraphQlTester;
+
+public class NestedPaths {
+
+	void nestedPaths() {
+		GraphQlTester graphQlTester = null;
+		String document = "";
+		// tag::nestedPaths[]
+		graphQlTester.document(document)
+				.execute()
+				.path("project", (project) -> project // <1>
+						.path("name").entity(String.class).isEqualTo("spring-framework")
+						.path("releases[*].version").entityList(String.class).hasSizeGreaterThan(1));
+		// end::nestedPaths[]
+	}
+}

spring-graphql-docs/src/main/java/org/springframework/graphql/docs/testing/rsocketgraphqltester/RSocketSetup.java

@@ -0,0 +1,37 @@
+/*
+ * Copyright 2020-2024 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.graphql.docs.testing.rsocketgraphqltester;
+
+import java.net.URI;
+
+import io.rsocket.transport.netty.client.WebsocketClientTransport;
+
+import org.springframework.graphql.test.tester.RSocketGraphQlTester;
+
+public class RSocketSetup {
+
+	void rSocketSetup() {
+		// tag::rsocketSetup[]
+		URI url = URI.create("wss://localhost:8080/rsocket");
+		WebsocketClientTransport transport = WebsocketClientTransport.create(url);
+
+		RSocketGraphQlTester client = RSocketGraphQlTester.builder()
+				.clientTransport(transport)
+				.build();
+		// end::rsocketSetup[]
+	}
+}

spring-graphql-docs/src/main/java/org/springframework/graphql/docs/testing/subscriptions/TestSubscriptions.java

@@ -0,0 +1,40 @@
+/*
+ * Copyright 2020-2024 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.graphql.docs.testing.subscriptions;
+
+import reactor.core.publisher.Flux;
+import reactor.test.StepVerifier;
+
+import org.springframework.graphql.test.tester.GraphQlTester;
+
+public class TestSubscriptions {
+
+	void testSubscriptions() {
+		GraphQlTester tester = null;
+		// tag::testSubscriptions[]
+		Flux<String> greetingFlux = tester.document("subscription { greetings }")
+				.executeSubscription()
+				.toFlux("greetings", String.class);  // decode at JSONPath
+
+		StepVerifier.create(greetingFlux)
+				.expectNext("Hi")
+				.expectNext("Bonjour")
+				.expectNext("Hola")
+				.verifyComplete();
+		// end::testSubscriptions[]
+	}
+}

spring-graphql-docs/src/main/java/org/springframework/graphql/docs/testing/webgraphqltester/WebSetup.java

@@ -0,0 +1,39 @@
+/*
+ * Copyright 2020-2024 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.graphql.docs.testing.webgraphqltester;
+
+import org.springframework.graphql.server.WebGraphQlHandler;
+import org.springframework.graphql.test.tester.WebGraphQlTester;
+
+public class WebSetup {
+
+	void webSetup() {
+		// tag::webSetup[]
+		WebGraphQlHandler handler = /**/ null;
+		WebGraphQlTester tester = WebGraphQlTester.create(handler);
+		// end::webSetup[]
+	}
+
+	void customWebSetup() {
+		// tag::customWebSetup[]
+		WebGraphQlHandler handler = /**/ null;
+		WebGraphQlTester tester = WebGraphQlTester.builder(handler)
+				.headers((headers) -> headers.setBasicAuth("joe", "..."))
+				.build();
+		// end::customWebSetup[]
+	}
+}

spring-graphql-docs/src/main/java/org/springframework/graphql/docs/testing/websocketgraphqltester/WsSetup.java

@@ -0,0 +1,54 @@
+/*
+ * Copyright 2020-2024 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.graphql.docs.testing.websocketgraphqltester;
+
+import java.net.URI;
+
+import org.springframework.graphql.test.tester.WebSocketGraphQlTester;
+import org.springframework.web.reactive.socket.client.ReactorNettyWebSocketClient;
+import org.springframework.web.reactive.socket.client.WebSocketClient;
+
+public class WsSetup {
+
+	void setup() {
+		// tag::setup[]
+		String url = "http://localhost:8080/graphql";
+		WebSocketClient client = new ReactorNettyWebSocketClient();
+
+		WebSocketGraphQlTester tester = WebSocketGraphQlTester.builder(url, client).build();
+		// end::setup[]
+	}
+
+	void customSetup() {
+		// tag::customSetup[]
+		URI url = URI.create("ws://localhost:8080/graphql");
+		WebSocketClient client = new ReactorNettyWebSocketClient();
+
+		WebSocketGraphQlTester tester = WebSocketGraphQlTester.builder(url, client)
+				.headers((headers) -> headers.setBasicAuth("joe", "..."))
+				.build();
+
+		// Use tester...
+
+		WebSocketGraphQlTester anotherTester = tester.mutate()
+				.headers((headers) -> headers.setBasicAuth("peter", "..."))
+				.build();
+
+		// Use anotherTester...
+		// end::customSetup[]
+	}
+}