Why error handling differs from REST in GraphQL - See It in Action

Understanding Error Handling Differences Between GraphQL and REST

📖 Scenario: You are working on a web application that uses both REST and GraphQL APIs. You want to understand how error handling works differently in GraphQL compared to REST to improve your API design and debugging skills.

🎯 Goal: Build a simple GraphQL schema and query that demonstrates how errors are handled differently from REST APIs.

📋 What You'll Learn

Create a GraphQL schema with a query that can return data or an error

Add a configuration variable to simulate error conditions

Write the core resolver logic that returns data or an error based on the configuration

Complete the schema with error handling fields to show error messages in the response

💡 Why This Matters

🌍 Real World

Understanding error handling in GraphQL helps developers build APIs that provide clear feedback to clients, improving debugging and user experience.

💼 Career

Many modern web applications use GraphQL APIs. Knowing how to handle errors properly is essential for backend developers, API designers, and full-stack engineers.

1

DATA SETUP: Define a GraphQL schema with a user query returning id and name

Create a GraphQL schema string called schema that defines a User type with fields id (ID!) and name (String!). Also define a Query type with a user field returning User.

GraphQL

schema = '''
# Define User type and Query type with user field
'''
# Your code here

Hint

Define the User type first, then the Query type with a user field.

2

CONFIGURATION: Add a variable simulate_error to control error simulation

Create a boolean variable called simulate_error and set it to True to simulate an error condition in the resolver.

GraphQL

schema = '''
type User {
  id: ID!
  name: String!
}

type Query {
  user: User
}
'''

# Create simulate_error variable
# Your code here

Hint

Just create a variable named simulate_error and assign True.

3

CORE LOGIC: Write a resolver function resolve_user that returns data or raises an error

Define a function called resolve_user that takes no arguments. If simulate_error is True, raise an exception with message 'User not found'. Otherwise, return a dictionary with id set to '1' and name set to 'Alice'.

GraphQL

schema = '''
type User {
  id: ID!
  name: String!
}

type Query {
  user: User
}
'''

simulate_error = True

# Define resolve_user function
# Your code here

Hint

Use an if statement to check simulate_error and raise an exception or return the user dictionary.

4

COMPLETION: Add error handling in the GraphQL execution to show errors in the response

Add code to execute the GraphQL query { user { id name } } using the schema and resolve_user resolver. Capture errors and include them in the response under the errors key, demonstrating how GraphQL returns errors alongside data.

GraphQL

schema = '''
type User {
  id: ID!
  name: String!
}

type Query {
  user: User
}
'''

simulate_error = True

def resolve_user():
    if simulate_error:
        raise Exception('User not found')
    return {'id': '1', 'name': 'Alice'}

# Execute GraphQL query with error handling
# Your code here

Hint

Use graphql_sync and build_schema from the graphql library. Pass root_value with user resolver. Check result.errors and add them to response.

Practice

1. In GraphQL, how are errors handled differently compared to REST APIs?

easy

A. GraphQL returns data and errors together in one response.

B. GraphQL stops execution and returns only errors without data.

C. GraphQL returns errors as HTTP status codes only.

D. GraphQL does not provide any error details to the client.

Solution

1. Step 1: Understand REST error handling

   REST APIs usually return errors as HTTP status codes and no data when an error occurs.

2. Step 2: Understand GraphQL error handling

   GraphQL returns both data and errors together in one response, allowing partial data delivery.

3. Final Answer:

   GraphQL returns data and errors together in one response. -> Option A

4. Quick Check:

   GraphQL response = data + errors [OK]

Hint: Remember GraphQL sends data and errors together [OK]

Common Mistakes:

• Thinking GraphQL only returns errors without data
• Confusing HTTP status codes with GraphQL error handling
• Assuming GraphQL hides error details

2. Which part of a GraphQL response contains error details?

easy

A. The data field

B. The HTTP status code

C. The errors field

D. The extensions field only

Solution

1. Step 1: Identify error location in GraphQL response

   GraphQL responses include an errors field that lists error messages and details.

2. Step 2: Differentiate from other fields

   The data field contains the requested data, HTTP status codes are not used for errors, and extensions may have extra info but not main errors.

3. Final Answer:

   The errors field -> Option C

4. Quick Check:

   Error details = errors field [OK]

Hint: Errors are always in the 'errors' field [OK]

Common Mistakes:

• Looking for errors in the data field
• Relying on HTTP status codes for errors
• Confusing extensions with errors

3. Given this GraphQL response:

{"data": {"user": null}, "errors": [{"message": "User not found", "path": ["user"]}]}

What does this response mean?

medium

A. The user exists but has no data.

B. The query failed completely and no data is returned.

C. The server returned a syntax error in the query.

D. Partial data is returned; user field is null due to an error.

Solution

1. Step 1: Analyze the data field

   The data field shows "user": null, meaning no user data was returned.

2. Step 2: Analyze the errors field

   The errors field shows "User not found" with path ["user"], indicating an error related to the user field.

3. Final Answer:

   Partial data is returned; user field is null due to an error. -> Option D

4. Quick Check:

   Partial data + error path = null field [OK]

Hint: Null data with errors means partial failure [OK]

Common Mistakes:

• Assuming no data means full failure
• Ignoring the errors field
• Thinking user exists without data

4. You receive this GraphQL response:

{"data": {"post": {"title": "Hello World"}}, "errors": [{"message": "Author not found", "path": ["post", "author"]}]}

What is the likely issue?

medium

A. The post data is returned but author field caused an error.

B. The server returned no data at all.

C. The entire query failed due to syntax error.

D. The author field is missing from the query.

Solution

1. Step 1: Check the data field

   The data field contains post with a title, so some data is returned.

2. Step 2: Check the errors field

   The error message "Author not found" with path ["post", "author"] shows the error is specific to the author field inside post.

3. Final Answer:

   The post data is returned but author field caused an error. -> Option A

4. Quick Check:

   Data present + error path = partial error [OK]

Hint: Error path shows which field failed [OK]

Common Mistakes:

• Assuming full query failure
• Ignoring error path details
• Thinking missing field means query error

5. Why does GraphQL include the error path in its error messages?

hard

A. To replace HTTP status codes for error classification.

B. To indicate the exact field causing the error for better client handling.

C. To hide sensitive server information from clients.

D. To provide a list of all fields in the query.

Solution

1. Step 1: Understand the purpose of error path

   The path shows the exact location in the query where the error happened.

2. Step 2: Understand client benefit

   This helps clients know which part of the data failed and handle partial data properly.

3. Final Answer:

   To indicate the exact field causing the error for better client handling. -> Option B

4. Quick Check:

   Error path = pinpoint error location [OK]

Hint: Error path points to problem field [OK]

Common Mistakes:

• Thinking path replaces HTTP status codes
• Assuming path hides server info
• Confusing path with full query fields