GraphQL Inspector
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.
Features
Major features:
- Compares schemas
- Finds breaking or dangerous changes
- Validates documents against a schema
- Finds similar / duplicated types
- Schema coverage based on documents
- Serves a GraphQL server with faked data and GraphQL Playground
GraphQL Inspector has a CLI and also a programmatic API, so you can use it however you want to and even build tools on top of it.
Installation
pnpm add @graphql-inspector/core
Examples
import {
diff,
validate,
similar,
coverage,
Change,
InvalidDocument,
SimilarMap,
SchemaCoverage
} from '@graphql-inspector/core'
// diff
const changes: Change[] = diff(schemaA, schemaB)
// validate
const invalid: InvalidDocument[] = validate(documentsGlob, schema)
// similar
const similar: SimilarMap = similar(schema, typename, threshold)
// coverage
const schemaCoverage: SchemaCoverage = coverage(schema, documents)
// ...
Diff warnings
diff skips directive usage comparison when either schema has no AST, for example when it was
built from introspection. Pass onWarning to be told when the comparison was skipped because only
one schema has an AST:
import { diff } from '@graphql-inspector/core'
const changes = await diff(oldSchema, newSchema, [], undefined, {
onWarning(warning) {
console.warn(warning.message)
}
})
License
MIT Kamil Kisiela