SchemGuard

🛡️ API 契约守护者 · 零配置变更检测

OpenAPI 规范变更检测工具,自动识别破坏性变更,保障 API 向后兼容性

收藏
2.9k
安装
1k
版本
0.1.2
CLS 安全扫描中
预计需要 3 分钟...

使用说明

SchemGuard 综合评估

SchemGuard 是一款专注于 OpenAPI 规范变更检测的开发者工具,通过对比 API 版本差异,精准识别破坏性变更(breaking changes)与兼容更新,主要面向 API 设计者、后端工程师及 DevOps 团队。

核心用法

工具提供三大功能模块:diff 对比新旧规范差异并分类变更影响;ci 集成到 CI/CD 流水线,以退出码 0/1/2 区分安全/破坏/错误状态;lint 检查规范质量。支持 JSON 输出便于自动化处理,同时暴露 MCP 协议接口供 AI 助手直接调用。

显著优点

  • 检测规则完善:覆盖端点删除、必填参数新增、字段类型变更、响应字段移除、枚举收窄、认证变更等 6 类高频破坏性场景
  • CI 友好设计:退出码机制无缝嵌入 GitHub Actions、GitLab CI 等主流流水线
  • 开发者体验:单条 npx 命令零配置启动,无需全局安装
  • 可扩展性:MCP 服务器模式支持 AI 编程助手原生集成

潜在局限

  • 作为 npm 包依赖 Node.js 环境,对纯 Python/Go 技术栈团队增加环境负担
  • 检测规则基于静态分析,无法捕获语义层面的逻辑破坏(如字段值范围隐性收缩)
  • 未提供官方 IDE 插件,需配合 CLI 或脚本使用

适合人群

  • 维护公共 API 或微服务契约的团队
  • 需要强制代码审查前 API 兼容性检查的组织
  • 频繁重构 API 并希望自动化回归验证的敏捷团队

常规风险

工具本身仅执行本地静态分析,不向外传输 API 定义,数据安全风险较低。主要风险在于误报/漏报导致部署决策失误:建议将 ci 模式与人工审查结合,对标记为破坏性的变更建立强制审批流程,避免过度信任自动化结果。

SchemGuard 内容

手动下载zip · 1.1 kB
SKILL.mdtext/markdown
请选择文件