Docs
Introduction
What is GraphQL Inspector?

What is GraphQL Inspector?

GraphQL Inspector is a set of tools to help you better maintain and improve GraphQL API as well as GraphQL consumers.

GraphQL Inspector outputs a list of changes between two GraphQL schemas. Every change is precisely explained and marked as breaking, non-breaking or dangerous. It will help you validate documents and fragments against a schema and even find similar or duplicated types.

Use GraphQL Inspector however you like:

The way GraphQL Inspector is built enables you to use everything through a CLI or each feature separately using one of many available packages. There's also a GitHub Application that you can install and use within seconds. If you're a fan of GitHub Actions, we got you covered too.

GitHub Application and Action

App and Action

💡

GraphQL Inspector GitHub Application is open-sourced, we host it so you don't have to.

Command Line Tool

💡

GraphQL Inspector has a CLI and also a programmatic API, so you can use it however you want to and even build tools on top of it.

Features

Detect Changes Between GraphQL Schemas

Prevent breaking changes and get a list of safe and dangerous modifications. Everything with a helpful explanation of why changes are breaking or dangerous to introduce.

Diff

Keep Operations and Fragments in Line with GraphQL Schema

Validates Operations and Fragments against a Schema and looks for deprecated usage. Inspector lets you write your own validation rules.

Validate

GitHub Application and GitHub Action

Use our Application and get everything up and running within a few seconds. If you prefer, you can have your own self-hosted GraphQL Inspector service or deploy it with Docker. You can also simply use our GitHub Action.

GitHub

Find Duplicated Types

Finds similar / duplicated types across your GraphQL Schema.

Similar

Schema coverage

Schema coverage based on Operations and Fragments. Find out how many times types and fields are used in your application and clean up your GraphQL Schema accordingly.

Coverage

Serve Faked GraphQL API

Serves a GraphQL server with faked data and GraphiQL

✅ Serving the GraphQL API on http://localhost:4000/

Introspect GraphQL API

Introspects a GraphQL API and writes the introspection result to a file.

✅ Introspection result saved to schema.json
Getting Started