Merge branch '1.3.x'

spring-graphql-docs/modules/ROOT/pages/controllers.adoc

@@ -920,37 +920,14 @@ Use `@GraphQlExceptionHandler` methods to handle exceptions from data fetching w
 flexible xref:controllers.adoc#controllers.exception-handler.signature[method signature]. When declared in a
 controller, exception handler methods apply to exceptions from the same controller:
 
-[source,java,indent=0,subs="verbatim,quotes"]
-----
-	@Controller
-	public class BookController {
-
-		@QueryMapping
-		public Book bookById(@Argument Long id) {
-			// ...
-		}
-
-		@GraphQlExceptionHandler
-		public GraphQLError handle(BindException ex) {
-			return GraphQLError.newError().errorType(ErrorType.BAD_REQUEST).message("...").build();
-		}
-	}
-----
+include-code::BookController[]
 
 When declared in an `@ControllerAdvice`, exception handler methods apply across controllers:
 
-[source,java,indent=0,subs="verbatim,quotes"]
-----
-	@ControllerAdvice
-	public class GlobalExceptionHandler {
+include-code::GlobalExceptionHandler[]
 
-		@GraphQlExceptionHandler
-		public GraphQLError handle(BindException ex) {
-			return GraphQLError.newError().errorType(ErrorType.BAD_REQUEST).message("...").build();
-		}
-
-	}
-----
+As shown in the examples above, you should build errors by injecting `GraphQlErrorBuilder` in the method signature
+because it's been prepared with the current `DataFetchingEnvironment`.
 
 Exception handling via `@GraphQlExceptionHandler` methods is applied automatically to
 controller invocations. To handle exceptions from other `graphql.schema.DataFetcher`

spring-graphql-docs/src/main/java/org/springframework/graphql/docs/controllers/exceptionhandler/Book.java

@@ -0,0 +1,20 @@
+/*
+ * Copyright 2020-2025 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.controllers.exceptionhandler;
+
+public record Book() {
+}

spring-graphql-docs/src/main/java/org/springframework/graphql/docs/controllers/exceptionhandler/BookController.java

@@ -0,0 +1,46 @@
+/*
+ * Copyright 2020-2025 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.controllers.exceptionhandler;
+
+
+import graphql.GraphQLError;
+import graphql.GraphqlErrorBuilder;
+
+import org.springframework.graphql.data.method.annotation.Argument;
+import org.springframework.graphql.data.method.annotation.GraphQlExceptionHandler;
+import org.springframework.graphql.data.method.annotation.QueryMapping;
+import org.springframework.graphql.execution.ErrorType;
+import org.springframework.stereotype.Controller;
+import org.springframework.validation.BindException;
+
+@Controller
+public class BookController {
+
+	@QueryMapping
+	public Book bookById(@Argument Long id) {
+		return /**/ new Book();
+	}
+
+	@GraphQlExceptionHandler
+	public GraphQLError handle(GraphqlErrorBuilder<?> errorBuilder, BindException ex) {
+		return errorBuilder
+				.errorType(ErrorType.BAD_REQUEST)
+				.message(ex.getMessage())
+				.build();
+	}
+
+}

spring-graphql-docs/src/main/java/org/springframework/graphql/docs/controllers/exceptionhandler/GlobalExceptionHandler.java

@@ -0,0 +1,38 @@
+/*
+ * Copyright 2020-2025 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.controllers.exceptionhandler;
+
+import graphql.GraphQLError;
+import graphql.GraphqlErrorBuilder;
+
+import org.springframework.graphql.data.method.annotation.GraphQlExceptionHandler;
+import org.springframework.graphql.execution.ErrorType;
+import org.springframework.validation.BindException;
+import org.springframework.web.bind.annotation.ControllerAdvice;
+
+@ControllerAdvice
+public class GlobalExceptionHandler {
+
+	@GraphQlExceptionHandler
+	public GraphQLError handle(GraphqlErrorBuilder<?> errorBuilder, BindException ex) {
+		return errorBuilder
+				.errorType(ErrorType.BAD_REQUEST)
+				.message(ex.getMessage())
+				.build();
+	}
+
+}