Repolode
graphql-hive

graphql-hive/graphql-inspector

用于比较 GraphQL Schema、识别破坏性变更、校验操作与片段的工具集。

Star
1,767
Fork
218
未关闭 Issue
132
最近提交
前天

这是什么?

GraphQL Inspector 用于比较两个 GraphQL Schema 之间的差异,并将每项变更标记为破坏性、非破坏性或危险变更,同时说明其影响。它还能将查询、Mutation 和 Fragment 与 Schema 对照校验,帮助在请求到达服务端之前发现无效操作。

除了对比差异,该项目还能在 Schema 中查找相似或重复的类型,并基于使用它的操作与片段统计 Schema 覆盖率。此外,它可以启动一个带模拟数据和 GraphiQL 的 GraphQL 服务。

工具提供 GitHub App、GitHub Action、CLI、Docker 镜像以及可在 TypeScript 和 JavaScript 项目中调用的编程 API。

核心功能

  • 01比较两个 Schema 并将每项变更标记为破坏性、非破坏性或危险变更。
  • 02将操作与片段对照 Schema 进行校验。
  • 03在 Schema 变更时发送通知。
  • 04查找相似或重复的类型。
  • 05基于操作和片段统计 Schema 覆盖率。
  • 06启动带模拟数据和 GraphiQL 的 GraphQL 服务。

适用场景

  • 在 Pull Request 中通过 GitHub Action 拦截破坏性 Schema 变更。
  • 在 CI 中部署前将客户端查询与 Schema 对照校验。
  • 检查客户端操作实际使用了 Schema 的哪些部分。
  • 清理大型 GraphQL API 中重复的类型。

标签

常见问题

graphql-inspector 是什么?
用于比较 GraphQL Schema、识别破坏性变更、校验操作与片段的工具集。 GraphQL Inspector 用于比较两个 GraphQL Schema 之间的差异,并将每项变更标记为破坏性、非破坏性或危险变更,同时说明其影响。它还能将查询、Mutation 和 Fragment 与 Schema 对照校验,帮助在请求到达服务端之前发现无效操作。
graphql-inspector 可以免费使用吗?用的什么许可证?
graphql-inspector 以 MIT 许可证开源。用于商业产品前,请先确认许可证条款。
graphql-inspector 还在维护吗?
活跃维护中。graphql-inspector 最近一次提交是在 2026年10月20日。
graphql-inspector 适合用来做什么?
在 Pull Request 中通过 GitHub Action 拦截破坏性 Schema 变更。 在 CI 中部署前将客户端查询与 Schema 对照校验。 检查客户端操作实际使用了 Schema 的哪些部分。 清理大型 GraphQL API 中重复的类型。
在哪里获取 graphql-inspector?
源代码和安装说明在 GitHub 上:https://github.com/graphql-hive/graphql-inspector

概要由 AI 根据项目 README 生成;GitHub 数据每日更新。

相关项目