api
@graphql-inspector/api
npm i @graphql-inspector/api
api

@graphql-inspector/api

🕵️‍♀️ Validate schema, get schema change notifications, validate operations, find breaking changes, look for similar types, schema coverage

by Kamil Kisiela

1.27.0 (see all)License:MITTypeScript:Not Found
npm i @graphql-inspector/api
Readme

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.

You may like GraphQL Hive as well!

It's an open-source performance monitoring tool and schema registry for GraphQL.

GraphQL Hive is currently available as a hosted service but it offers self-hosting as well.

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/introduction.

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

VersionTagPublished
1.27.0
latest
3yrs ago
0.0.0-d99f4ac.0
canary
3yrs ago
1.15.0-rc.18
next
4yrs ago
No alternatives found
No tutorials found
Add a tutorial
No dependencies found

Rate & Review

100
No reviews found
Be the first to rate