Skip to content

InstantMock allows teams to quickly create mock GraphQL endpoints to eliminate delays and bottlenecks for front-end and QA teams caused by backend API readiness.

Notifications You must be signed in to change notification settings

xolvio/instant-mock

Repository files navigation

🚀 @xolvio/instant-mock

InstantMock is an enterprise-ready Express.js server and React UI for creating and distributing GraphQL mock servers—designed to simplify API mocking across development teams.

With first-class Apollo Federation integration, you can instantly mock any Supergraph, Subgraph, or Schema Proposal.

Not using Apollo? No worries! InstantMock supports any valid GraphQL schema.

⏩ Quick Start

Requirements

  • Apollo Studio: Generate a user: API key here if using Apollo Studio schemas.
  • Local Files: To use schema files, place .graphql files in backend/src/graphql.

Running Locally

Clone the repo and run:

npm start

Or use Docker Compose:

docker compose up

Or, if you don't want to clone the repo, pull from Docker Hub:

docker pull xolvio/instant-mock:<version>
docker run -it -p 3033:3033 xolvio/instant-mock:<version>

InstantMock will be available on http://localhost:3033.

To connect with Apollo, go to the settings page and enter your key: http://localhost:3033/settings.

🔮 Coming Soon: npx create-instant-mock for even quicker start.

💡 Why InstantMock?

Problem

GraphQL Federation teams often struggle with:

  • Managing complex supergraph schemas across teams
  • Maintaining consistent mock data
  • Time spent creating and updating mock servers
  • Integration testing with proposed schema changes

Solution

InstantMock provides:

  • Centralized mock data management
  • Native Federation support (supergraphs/subgraphs)
  • GUI for creating and managing mocks
  • Instant deployment of mock responses

Enterprise Features

  • Security: Encryption key management, secure data storage
  • Infrastructure: HTTP proxy support, K8s-ready deployment
  • Flexibility: SQLite, PostgreSQL, or MySQL support
  • Data Control: Idempotent seed management with group organization
  • SSO Support: Currently support Github and Azure SSO.

Key Benefits

  • Faster Development: Create and share mocks in minutes
  • Better Testing: Consistent mock data across teams
  • Federation Ready: Test schema changes before deployment
  • No Setup: Replace local mock servers and manual JSON files

🔮 Coming Soon: More SSO provider support, file uploads, and enhanced Helm charts with PostgreSQL

🚢 Deployment Options

Docker

InstantMock is containerized for easy deployment in Docker-supported environments.

docker pull xolvio/instant-mock:<version>

Kubernetes (K8s)

A basic Helm chart is provided to deploy InstantMock with Kubernetes. Currently, it ships with SQLite and is limited to a single replica.

🔮 Coming Soon: Full Helm chart with scaling support and PostgreSQL.

🙏 Acknowledgments

InstantMock builds on the work from gqmock, with many of the base MockServer utilities adapted and extended for seamless integration.

Made with ❤️ by the @xolvio team

About

InstantMock allows teams to quickly create mock GraphQL endpoints to eliminate delays and bottlenecks for front-end and QA teams caused by backend API readiness.

Resources

Stars

Watchers

Forks

Packages

No packages published

Contributors 3

  •  
  •  
  •  

Languages