kamilkisiela/graphql-inspector

GraphQL Inspector Docker镜像

镜像概述

GraphQL Inspector是一套针对GraphQL的工具集，能够输出两个GraphQL模式之间的变更列表，精确解释每个变更并标记为破坏性、非破坏性或危险类型。它可帮助验证文档和片段与模式的兼容性，还能查找相似或重复的类型。该Docker镜像提供了便捷的容器化部署方式，支持多种使用场景。

核心功能与特性

• 模式比较：对比两个GraphQL模式，生成详细变更列表
• 变更检测：精确标记变更类型（破坏性、非破坏性、危险）
• 变更通知：支持模式变更的通知机制
• 无服务器验证：可通过无服务器函数验证模式变更
• 文档验证：验证GraphQL操作和片段与模式的兼容性
• 类型分析：识别相似或重复的模式类型
• 覆盖率分析：基于操作和片段的模式覆盖率统计
• 模拟服务：提供带模拟数据的GraphQL服务器及GraphiQL界面
• 容器化部署：提供Docker镜像，简化环境配置

适用场景

• CI/CD流程：集成到持续集成/部署流程中，自动检测模式变更对现有客户端的影响
• 开发验证：开发阶段验证GraphQL文档（查询、变更等）与模式的一致性
• 团队协作：维护团队共享的GraphQL模式，确保变更符合规范
• 版本管理：跟踪模式演进，记录破坏性变更以辅助版本控制决策
• 教学与调试：通过模拟服务快速搭建GraphQL环境，辅助学习和调试

使用方法

基本使用

通过Docker运行GraphQL Inspector CLI命令，基本格式如下：

bash
docker run --rm kamilkisiela/graphql-inspector [COMMAND] [OPTIONS]

常用命令示例

1. 比较两个模式文件

bash
# 比较本地两个模式文件（需挂载本地目录）
docker run --rm -v $(pwd):/app kamilkisiela/graphql-inspector compare /app/schema-old.graphql /app/schema-new.graphql

2. 验证文档与模式的兼容性

bash
# 验证文档文件与模式的兼容性
docker run --rm -v $(pwd):/app kamilkisiela/graphql-inspector validate /app/documents.graphql --schema /app/schema.graphql

3. 分析模式覆盖率

bash
# 基于文档文件分析模式覆盖率
docker run --rm -v $(pwd):/app kamilkisiela/graphql-inspector coverage /app/documents.graphql --schema /app/schema.graphql

详细文档

完整使用说明及配置选项请参考官方文档：graphql-inspector.com/docs

相关信息

部分功能源自Ruby的https://github.com/xuorig/graphql-schema_comparator%E9%A1%B9%E7%9B%AE%E7%9A%84NodeJS%E7%A7%BB%E6%A4%8D%E7%89%88%E6%9C%AC%E3%80%82

许可证

https://github.com/kamilkisiela/graphql-inspector/blob/master/LICENSE © Kamil Kisiela