How do I set up GraphQL Faker to mock a GraphQL API?

Install it globally via npm, run 'graphql-faker --open' with an SDL file (or use the default), and use the interactive editor to add directives like @fake to fields. This starts a local server on port 9002 serving the mocked API.

GraphQL Faker vs Apollo Server mocking: which should I use?

GraphQL Faker is better for declarative, no-code mocking using SDL, while Apollo Server offers more programmatic control with custom resolvers. Choose GraphQL Faker for quick setup, Apollo for complex logic.

Can GraphQL Faker handle mutations with fake data?

Yes, you can apply @fake or @examples directives to mutation fields in the SDL to simulate backend responses. However, it's static mocking and doesn't support state changes across requests.

How to extend an existing GraphQL API with GraphQL Faker?

Use the --extend flag with the URL of the real GraphQL server and provide an SDL file with additional types or fields decorated with directives. It proxies requests, merging real and fake data seamlessly.

Is GraphQL Faker good for automated testing?

It's useful for development and manual testing, but its static data generation may not suit complex test cases requiring dynamic behaviors. For automated tests, consider tools like Jest with custom mocks.

What are the best alternatives to GraphQL Faker for mocking?

Alternatives include Mock Service Worker (MSW) for intercepting network requests, GraphQL Tools' mock functions, and built-in mocking in Apollo Server. Each varies in flexibility and setup complexity.

Open-Awesome

GraphQL Faker

MITTypeScript

Mock or extend GraphQL APIs with realistic fake data using directives, no coding required.

GitHub

2.7k stars229 forks0 contributors

What is GraphQL Faker?

GraphQL Faker is a tool that mocks or extends GraphQL APIs with realistic fake data. It allows developers to create a functional GraphQL server using only GraphQL SDL and custom directives, enabling parallel development without a real backend. It solves the problem of frontend teams waiting for backend APIs to be ready by providing instant, realistic mock data.

Target Audience

GraphQL developers, frontend engineers, and full-stack teams who need to mock APIs for development, testing, or prototyping. It's especially useful for teams practicing API-first development or working in parallel on frontend and backend.

Value Proposition

Developers choose GraphQL Faker because it requires no coding, integrates seamlessly with existing GraphQL APIs via proxying, and offers a rich set of fake data types with an intuitive directive-based approach. Its interactive editor and autocompletion make it easy to use without memorizing syntax.

Overview

🎲 Mock or extend your GraphQL API with faked data. No coding required.

Use Cases

Best For

Mocking GraphQL APIs during frontend development when the backend is not ready
Extending existing GraphQL APIs with additional fake data for testing new features
Creating realistic prototypes and demos without a real backend
Testing GraphQL queries and mutations with varied fake data scenarios
Enabling parallel development between frontend and backend teams
Generating fake data for GraphQL schemas using SDL directives

Not Ideal For

Production environments where data integrity, security, and real backend logic are critical
Projects using REST, gRPC, or other non-GraphQL API specifications
Teams needing stateful mocks or complex business logic simulation beyond static data generation
Scenarios requiring high-performance, scalable mock servers for load testing or large-scale simulations

Pros & Cons

Pros

No-Code Mock Setup

Operates entirely through GraphQL SDL with custom directives like @fake and @examples, eliminating the need for custom JavaScript code to generate mock data.

Rich Fake Data Library

Integrates 60+ faker types from faker.js with support for multiple locales, providing realistic data such as names, addresses, and images directly in the SDL.

Seamless API Extension

Can proxy real GraphQL APIs and extend them with faked data using the --extend flag, enabling incremental development and testing without disrupting existing endpoints.

Interactive Development Experience

Includes an embedded SDL editor with autocompletion for directives and an integrated GraphiQL interface, streamlining mock configuration and query testing.

Cons

GraphQL-Only Limitation

Exclusively designed for GraphQL APIs, making it unsuitable for teams working with REST, gRPC, or other protocols, which restricts its utility in mixed-stack projects.

Static Mocking Constraints

Relies on predefined directives for data generation, lacking support for dynamic or stateful mocking scenarios that require custom JavaScript logic or conditional responses.

Dependency on Faker.js

Data generation capabilities are tied to faker.js, so if specific data types are not covered, users have limited options without external workarounds or modifications.

Frequently Asked Questions

Related Projects

mockd

High-performance, multi-protocol mock server. HTTP, WebSocket, gRPC, MQTT, SSE, GraphQL, SOAP in one binary.

Stars132

Forks5

Last commit3 days ago

graphql-to-karate

Automagically generate Karate API tests from your GraphQL schemas. Useful for test-driven development, change validation in CI/CD, and more.

Stars17

Forks1

Last commit5 hours ago

Microcks

The open source (CNCF project), cloud native tool for API Mocking and Testing with GraphQL support 🎥 GraphQL conf 2023

Open-Source API Testing and Monitoring with GraphQL support