GraphQL Inspector App is a GitHub Application that you can install in any of your repositories.
GraphQL Inspector App checks your Pull Request in order to find breaking changes (and others) in a GraphQL Schema, against your
We strongly believe in Open Source and that's why we made it possible to have a per-repository, self-hosted GraphQL Inspector App thanks to GitHub Actions or to host your own instance in the Cloud.
- Detect changes
- Schema change notifications
- In-Code annotations
- Intercept checks with serverless functions
- Use many environments
- Use live and running GraphQL endpoints
GraphQL Inspector App comes with a free plan and that's the only plan.
Visit the application on marketplace and enable it in your project:
Pick a free plan:
Select repositories and click Install:
Configure GraphQL Inspector in
It's also possible to setup everything in
package.json (it must be placed in the root directory).
schema.graphql points to a file in root directory of a repository.
Schema change notifications
To stay up to date with changes in your GraphQL Schema and to receive notifications on Slack, Discord or even via WebHooks, read the "Notifications" chapter.
In some cases you want to get a summary of changes but no annotations on a schema file. Annotations are enabled by default but to disabled them, please follow the instructions in "Annotations" chapter.
Detection of changes
By default, GraphQL Inspector fails the Pull Request when it detects some breaking changes. To force a successful check just set
Using GraphQL Endpoint
Read more about using live and running GraphQL endpoint as source of schema.
Using multiple environments
Read more about managing many environments.
Intercept checks with serverless functions
We recommend to automate the generation of
schema.graphql and use
husky to run
$ graphql-inspector introspect:
This way your schema file is always up to date with your actual schema.
Now on every commit or every Pull Request the GraphQL Inspector App will annotate every change, next to the line in code where it happened.
Deploy your own GraphQL Inspector App
We strongly believe in Open Source and that's why we made it possible to host your own instances of GraphQL Inspector App.
Under the hood, the GraphQL Inspector uses Probot, a bot made by GitHub team.
There's a well written "Deployment" chapter on Probot's documentation.