Repolode
Submit
graphql-hive

graphql-hive/graphql-inspector

A toolkit for comparing GraphQL schemas, flagging breaking changes, validating operations, and finding similar types.

View on GitHubWebsite
Stars
1,767
Forks
218
Open issues
132
Last commit
2 days ago

What is it?

GraphQL Inspector lists the differences between two GraphQL schemas and labels each change as breaking, non-breaking, or dangerous, with an explanation of its impact. It can also check queries, mutations, and fragments against a schema, which helps catch invalid operations before they reach a server.

Beyond diffing, the project finds similar or duplicated types within a schema and reports schema coverage based on the operations and fragments that use it. It can also serve a mock GraphQL server with faked data and GraphiQL.

The tool is available as a GitHub App, a GitHub Action, a CLI, a Docker image, and a programmatic API for TypeScript and JavaScript projects.

Key features

  • 01Compares two schemas and explains each change as breaking, non-breaking, or dangerous.
  • 02Validates operations and fragments against a schema.
  • 03Sends notifications for schema changes.
  • 04Finds similar or duplicated types.
  • 05Reports schema coverage from operations and fragments.
  • 06Serves a mock GraphQL server with faked data and GraphiQL.

Use cases

  • Blocking breaking schema changes in pull requests with the GitHub Action.
  • Checking client queries against a schema in CI before deployment.
  • Auditing which parts of a schema are actually used by client operations.
  • Cleaning up duplicated types in a large GraphQL API.

Topics

#graphql#schema#api#breaking-changes#linting#typescript#github-action#javascript#monitoring#probot-app

FAQ

What is graphql-inspector?
A toolkit for comparing GraphQL schemas, flagging breaking changes, validating operations, and finding similar types. GraphQL Inspector lists the differences between two GraphQL schemas and labels each change as breaking, non-breaking, or dangerous, with an explanation of its impact. It can also check queries, mutations, and fragments against a schema, which helps catch invalid operations before they reach a server.
Is graphql-inspector free to use? What license does it have?
graphql-inspector is open source under the MIT license. Check the license terms before using it in commercial products.
Is graphql-inspector still maintained?
Actively maintained. The last commit to graphql-inspector was on Oct 20, 2026.
What can I use graphql-inspector for?
Blocking breaking schema changes in pull requests with the GitHub Action. Checking client queries against a schema in CI before deployment. Auditing which parts of a schema are actually used by client operations. Cleaning up duplicated types in a large GraphQL API.
Where can I get graphql-inspector?
The source code and installation instructions are on GitHub: https://github.com/graphql-hive/graphql-inspector

Summary generated by AI from the project's README. GitHub stats refresh daily.

Related projects