Custom Error Handling in GraphQL
Implement custom exception handling and format error responses according to GraphQL best practices.
Custom Error Handling in GraphQL is a free GraphQL APIs with Spring Boot lesson on CoddyKit — lesson 1 of 4. You can read the complete lesson below for free — then practise it hands-on in the browser with a built-in code editor and a 24/7 AI tutor. It is part of the GraphQL APIs with Spring Boot learning path, one of 4 lessons in the course, and your progress syncs across the web and the CoddyKit app.
Understanding GraphQL Errors
When something goes wrong in a GraphQL operation, the server typically returns an errors array in the response. This array contains objects describing what went wrong.
By default, these error messages can be generic or even expose sensitive internal details like stack traces, which isn't ideal for production APIs.
Spring GraphQL's Default Behavior
Out-of-the-box, Spring GraphQL often maps Java exceptions (like RuntimeException) thrown by your data fetchers into a standard DataFetchingException. While functional, this default behavior might not provide the specific, user-friendly details your clients need.
Why Customize Error Responses?
Customizing error handling offers significant benefits:
- Improved UX: Provide clear, actionable messages for end-users.
- Enhanced Security: Prevent exposure of sensitive internal information (e.g., database errors, full stack traces).
- Client-Side Logic: Include custom error codes or details that frontend applications can use to react specifically to different error types.
Meet DataFetcherExceptionResolver
In Spring GraphQL, the primary way to customize error responses is by implementing the DataFetcherExceptionResolver interface. This powerful interface allows you to intercept any exception thrown by a data fetcher and transform it into a structured GraphQLError object.
Define Your Custom Error
First, let's create a simple custom exception. This helps categorize specific error scenarios in your application. For example, a ResourceNotFoundException:
public class ResourceNotFoundException extends RuntimeException {
private final String resourceId;
public ResourceNotFoundException(String message, String resourceId) {
super(message);
this.resourceId = resourceId;
}
public String getResourceId() {
return resourceId;
}
}Building Your Custom Resolver
Now, we'll create a class that implements DataFetcherExceptionResolver. This class will inspect the thrown exception and build a custom GraphQLError, potentially adding specific details via extensions.
import graphql.GraphQLError;
import graphql.execution.DataFetcherExceptionHandler;
import graphql.execution.DataFetcherExceptionHandlerParameters;
import graphql.execution.DataFetcherExceptionHandlerResult;
import graphql.error.ErrorType;
import java.util.HashMap;
import java.util.Map;
public class CustomExceptionResolver implements DataFetcherExceptionHandler {
@Override
public DataFetcherExceptionHandlerResult onException(
DataFetcherExceptionHandlerParameters handlerParameters) {
Throwable exception = handlerParameters.getException();
if (exception instanceof ResourceNotFoundException) {
ResourceNotFoundException rnfEx = (ResourceNotFoundException) exception;
Map<String, Object> extensions = new HashMap<>();
extensions.put("errorCode", "NOT_FOUND");
extensions.put("resourceId", rnfEx.getResourceId());
GraphQLError error = GraphQLError.newError()
.message(rnfEx.getMessage())
.locations(handlerParameters.getSourceLocation())
.path(handlerParameters.getPath())
.extensions(extensions)
.errorType(ErrorType.DataFetchingException)
.build();
return DataFetcherExceptionHandlerResult.newResult().error(error).build();
}
// Fallback for unhandled exceptions
return DataFetcherExceptionHandlerResult.newResult()
.error(GraphQLError.newError()
.message("An unexpected error occurred.")
.errorType(ErrorType.DataFetchingException)
.build())
.build();
}
}Activating Your Custom Resolver
To make Spring GraphQL use your CustomExceptionResolver, you need to register it as a Spring @Bean in your application's configuration. This tells Spring to include it in the GraphQL execution chain.
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
import graphql.execution.DataFetcherExceptionHandler;
@Configuration
public class GraphQLConfig {
@Bean
public DataFetcherExceptionHandler customDataFetcherExceptionHandler() {
return new CustomExceptionResolver();
}
}See It in Action!
Let's run a simplified Spring Boot app. If you query for an item with an ID other than '1', our custom error resolver will catch the DemoResourceNotFoundException and format the error response with specific details in the extensions field.
import org.springframework.boot.SpringApplication;
import org.springframework.boot.autoconfigure.SpringBootApplication;
import org.springframework.context.annotation.Bean;
import org.springframework.stereotype.Component;
import graphql.kickstart.tools.GraphQLQueryResolver;
import graphql.execution.DataFetcherExceptionHandler;
import graphql.execution.DataFetcherExceptionHandlerParameters;
import graphql.execution.DataFetcherExceptionHandlerResult;
import graphql.GraphQLError;
import graphql.error.ErrorType;
import java.util.HashMap;
import java.util.Map;
// Main Application Class
@SpringBootApplication
public class ErrorDemoApp {
public static void main(String[] args) {
SpringApplication.run(ErrorDemoApp.class, args);
}
@Bean
public GraphQLQueryResolver queryResolver() {
return new DemoQueryResolver();
}
@Bean
public DataFetcherExceptionHandler customDataFetcherExceptionHandler() {
return new CustomErrorResolver();
}
// Custom Exception
static class DemoResourceNotFoundException extends RuntimeException {
private final String resourceId;
public DemoResourceNotFoundException(String msg, String id) {
super(msg); this.resourceId = id;
}
public String getResourceId() { return resourceId; }
}
// Data Fetcher
@Component
static class DemoQueryResolver implements GraphQLQueryResolver {
public String getItem(String id) {
if ("1".equals(id)) {
return "Item Found: " + id;
}
throw new DemoResourceNotFoundException("Item not found", id);
}
}
// Custom Error Resolver
@Component
static class CustomErrorResolver implements DataFetcherExceptionHandler {
@Override
public DataFetcherExceptionHandlerResult onException(
DataFetcherExceptionHandlerParameters params) {
Throwable ex = params.getException();
if (ex instanceof DemoResourceNotFoundException) {
DemoResourceNotFoundException rnfEx = (DemoResourceNotFoundException) ex;
Map<String, Object> ext = new HashMap<>();
ext.put("code", "ITEM_NOT_FOUND");
ext.put("itemId", rnfEx.getResourceId());
GraphQLError error = GraphQLError.newError()
.message(rnfEx.getMessage())
.locations(params.getSourceLocation())
.extensions(ext)
.errorType(ErrorType.DataFetchingException)
.build();
return DataFetcherExceptionHandlerResult.newResult().error(error).build();
}
return DataFetcherExceptionHandlerResult.newResult()
.error(GraphQLError.newError()
.message("Unexpected error")
.errorType(ErrorType.DataFetchingException)
.build())
.build();
}
}
}Error Extensions for Context
The extensions map within a GraphQLError is a powerful feature. It allows you to include custom, machine-readable data (like errorCode, resourceId, or validation errors) that clients can use for advanced error handling logic, beyond just the human-readable message.
Best Practices for Errors
To ensure robust error handling in your GraphQL API:
- Be Specific: Use distinct custom exceptions for different error types.
- Hide Internals: Never expose raw stack traces or database errors in production environments.
- Consistent Format: Ensure your custom errors always follow a predictable structure.
- Client-Friendly: Provide clear messages and actionable codes for frontend logic.
Quick Check: Error Handling
Which interface is primarily used in Spring GraphQL to customize how Java exceptions are transformed into GraphQLError objects?
Recap: Custom Error Handling
We learned how to move beyond default GraphQL error messages by implementing custom exception handling in Spring Boot. You can create custom exceptions, use the DataFetcherExceptionResolver to catch them, and format precise GraphQLError objects with useful extensions. This improves API security, user experience, and client-side error management.
Frequently asked questions
Is the “Custom Error Handling in GraphQL” lesson free?
Yes — the full text of “Custom Error Handling in GraphQL” is free to read here on the web, and the GraphQL APIs with Spring Boot course includes 4 lessons in total. To practise it interactively (a built-in code editor and a 24/7 AI tutor) and unlock the rest of the GraphQL APIs with Spring Boot course, upgrade to CoddyKit PRO.
What will I learn in “Custom Error Handling in GraphQL”?
Implement custom exception handling and format error responses according to GraphQL best practices. You practise GraphQL APIs with Spring Boot with hands-on code you run directly in the browser, and a 24/7 AI tutor answers your questions as you work through the lesson.
Do I need any experience to start GraphQL APIs with Spring Boot?
No prior experience is required. GraphQL APIs with Spring Boot on CoddyKit is structured for beginners through advanced learners; this is — lesson 1 of 4, so you can start here or from the beginning and move at your own pace.
How long does the “Custom Error Handling in GraphQL” lesson take?
Most CoddyKit lessons take about 5–10 minutes. Each one is bite-sized and interactive, so you make steady progress and pick up exactly where you left off across the web and the app.
Can I write and run code in this GraphQL APIs with Spring Boot lesson?
Yes. Every GraphQL APIs with Spring Boot lesson includes a built-in code editor, so you write and run real code right in your browser and get instant AI feedback — no local setup required.
All lessons in this course
- Custom Error Handling in GraphQL
- Authentication with Spring Security
- Authorization with Directives and Context
- Rate Limiting and Query Depth Protection