Keep your GraphQL schema honest
Validate schemas and detect changes. Receive schema change notifications. Keep operations and fragments consistent. Part of the Hive ecosystem by The Guild.
- Breaking-change detection
- GitHub Action and CLI
- Coverage and validation
Use it however you work
The same checks are available as a GitHub Action, in your CI, from the command line, and as a library.
- Works with GitHubCheck every pull request with the GitHub Action: breaking, dangerous and safe changes, annotated in the diff.
- CI/CDRuns in any continuous integration service with a modular, CI-suited version of the CLI.
- Command lineDiff schemas, validate documents, measure coverage, find similar types and audit operations from your terminal.
- Programmatic APIEvery command is a function in @graphql-inspector/core, ready to build your own tooling on top of.
Every change, classified
Inspector compares two schemas and explains each difference as breaking, dangerous or safe. This is the output of graphql-inspector difffor the two schemas below.
Before
type Post {
id: ID!
title: String
createdAt: String
modifiedAt: String
}
type Query {
post: Post!
posts: [Post!]
}After
type Post {
id: ID!
title: String!
createdAt: String
}
type Query {
post: Post!
}3 changes detected
- Breaking
Field 'modifiedAt' was removed from object type 'Post'
- Safe
Field 'Post.title' changed type from 'String' to 'String!'
- Breaking
Field 'posts' was removed from object type 'Query'
Detect changes
Prevent breaking changes on pull requests and pushes. Get a detailed summary of every proposed change to the schema and decide whether to accept it.
Learn more →
In-code annotations
The GitHub Action annotates the schema file in the pull request diff, so the exact line of each change is visible where it was made.
Learn more →
Notifications
Stay up to date with changes in your GraphQL schema. Receive notifications on Slack, Discord or via webhooks whenever changes land.
Learn more →
Intercept via HTTP
On every schema check, your HTTP endpoint receives the list of changes and the pull request or commit. You decide the outcome.
Learn more →
The engine behind Hive's schema registry
GraphQL Hive runs Inspector's change detection on every schema publish, across all your services, with usage data to tell you whether a breaking change is actually breaking anyone. Cloud-hosted or self-hosted, on top of the same open-source core.
Explore HiveDiscover the complete ecosystem of tools and libraries
Complete GraphQL Federation Stack
Our libraries to support all your GraphQL needs
Explore the Ecosystem