GraphQL Mocking

Understanding mocking helps you work with GraphQL confidently. Here you will learn the core ideas behind mocking, see working code, and pick up best practices used on real teams.

Mocking Overview

Mocking is a building block you will reach for often in GraphQL. It keeps related logic together and makes your intent obvious to reviewers and future maintainers.

When you learn mocking properly, you avoid the guesswork that leads to bugs and rework. The example below shows the shape you will use in most real GraphQL projects.

import assert from 'node:assert';

const res = await server.executeOperation({
  query: 'query { users { id name } }',
});
assert.equal(res.body.singleResult.errors, undefined);

Execute operations against the server in tests and assert on the response body.

Mocking Example

const typeDefs = gql`
  type Query { hello: String! }
`;
const resolvers = { Query: { hello: () => 'world' } };
const server = new ApolloServer({ typeDefs, resolvers });

Start from a minimal Mocking example and grow it only as needed.
Keep configuration explicit so Mocking behaves the same in every environment.
Name things clearly so teammates understand your Mocking at a glance.
Add tests around Mocking early to lock in expected behaviour.

GraphQL Cheatsheet

Quick GraphQL reference related to mocking.

Concept	Example	Purpose
Schema	`type Query { user(id: ID!): User }`	Define the API shape
Resolver	`Query: { user: (_, { id }) => ... }`	Provide field data
Query	`query { user(id: 1) { name } }`	Read exactly what you need
Mutation	`mutation { createUser(input) { id } }`	Change data
Subscription	`subscription { postAdded { id } }`	Real-time updates
Context	`context: ({ req }) => ({ user })`	Auth and shared state
DataLoader	`loader.load(id)`	Batch to avoid N+1

How Mocking Works in GraphQL

Mocking fits into GraphQL's model of a single typed schema that clients query for exactly the data they need. The server resolves each requested field through resolver functions.

Execute operations against the server in tests and assert on the response body.

The schema is the contract between client and server.
Resolvers fetch data field by field, including nested types.
Clients request only the fields they use, avoiding over-fetching.
Context carries auth and shared services into every resolver.

Practical Guidance for Mocking

In production, mocking should be efficient and secure. Batch data access with DataLoader, guard resolvers with authorization, and limit query depth and complexity.

Concern	Recommendation
N+1 queries	Batch with DataLoader
Security	Auth in context, depth/complexity limits
Errors	Typed GraphQLError with extension codes
Performance	Cache and paginate large lists

Common Mistakes

Skipping error handling and edge cases when wiring up mocking.
Leaving mocking untested, so regressions slip into production.
Over-engineering mocking before you actually need the extra flexibility.
Ignoring documentation, which makes mocking hard for the next developer to change.

Key Takeaways

Mocking is a core part of working effectively with GraphQL.
Start small and keep mocking focused on a single responsibility.
Apply consistent patterns so mocking scales across your project.
Test and document mocking to keep it maintainable over time.

Pro Tip

Pair mocking with automated tests from day one. It is far cheaper to catch GraphQL regressions in CI than in production.