Skip to content
search

GitHub Action

GraphQL Inspector

v2.6.2 Latest version
Use latest version
search

GraphQL Inspector

Tooling for GraphQL. Compare schemas, find breaking changes, find similar types

Installation

Copy and paste the following snippet into your .yml file.

- name: GraphQL Inspector
  uses: kamilkisiela/graphql-inspector@v2.6.2
Learn more about this action in kamilkisiela/graphql-inspector
Choose a version

Inspector

npm version Docker Pulls code style: prettier renovate-app badge Discord Chat

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 helps you validate documents and fragments against a schema and even find similar or duplicated types.

Use GraphQL Inspector however you want:

Features

  • Compares schemas
  • Detect breaking or dangerous changes
  • Schema change notifications
  • Use serverless functions validate changes
  • Validates Operations and Fragments against a schema
  • Finds similar / duplicated types
  • Schema coverage based on Operations and Fragments
  • Serves a GraphQL server with faked data and GraphiQL
  • Docker Image

Use on GitHub

Github

Use everywhere

Example

Installation and Usage

Visit our website graphql-inspector.com to learn more about the project.

Documentation

Documentation is available at graphql-inspector.com/docs.

Related

Some part of the library was ported to NodeJS from Ruby's GraphQL Schema Comparator

Contributions

Contributions, issues and feature requests are very welcome. If you are using this package and fixed a bug for yourself, please consider submitting a PR!

And if this is your first time contributing to this project, please do read our Contributor Workflow Guide before you get started off.

Code of Conduct

Help us keep GraphQL Inspector open and inclusive. Please read and follow our Code of Conduct as adopted from Contributor Covenant

License

MIT © Kamil Kisiela