Getting started

GraphQL Testing Library provides utilities for creating Mock Service Worker (MSW) request handlers for GraphQL APIs.

This guide will help you get started with MSW, create a request handler using a GraphQL schema and begin writing tests that can run in Node.js, the browser or React Native.

Tip

Just as MSW allows you to “write client-agnostic mocks and reuse them across any frameworks, tools, and environments,” GraphQL Testing Library is also client-agnostic: you can use it with any GraphQL client, or no client at all!

Installation

GraphQL Testing Library has peerDependencies listings for msw at ^2.0.0 and graphql at ^15.0.0 || ^16.0.0.

Install them along with this library using your preferred package manager:

npm

npm install --save-dev @apollo/graphql-testing-library msw graphql

pnpm

pnpm add --save-dev @apollo/graphql-testing-library msw graphql

Yarn

yarn add --dev @apollo/graphql-testing-library msw graphql

Bun

bun add --dev @apollo/graphql-testing-library msw graphql