SchemGuard

SchemGuard是什么

SchemGuard是一款专注于OpenAPI规范的开发工具，旨在帮助开发者检测API规范中的破坏性更改，确保API变更的向后兼容性和安全性。

由 sethclawd-prog 开发 | 累计安装 301 次 | 开源协议：MIT-0

SchemGuard的主要功能

• 破坏性更改检测：自动检测API规范中的端点删除、必填参数新增、字段类型更改等破坏性更改。
• 向后兼容性验证：确保API变更不会影响现有客户端，保持向后兼容性。
• PR审查：在代码审查过程中，自动检测PR中API规范的更改，避免潜在的风险。
• 代码风格检查：提供代码风格检查功能，确保API规范的一致性和可维护性。
• JSON输出：支持JSON格式输出，方便程序集成和使用。

如何使用SchemGuard

• 安装工具：使用npx安装SchemGuard：npx @sethclawd/schemaguard。
• 比较规范：使用diff命令比较新旧API规范：npx @sethclawd/schemaguard diff old.yaml new.yaml。
• CI检查：在CI流程中集成SchemGuard，确保API变更的安全性：npx @sethclawd/schemaguard ci --spec ./openapi.ya
• 规范质量检查：使用lint命令检查API规范的质量：npx @sethclawd/schemaguard lint ./openapi.yaml。
• JSON输出：使用--format json参数获取JSON格式的输出结果。

SchemGuard的项目地址

• 项目官网：https://clawhub.ai/sethclawd-prog/schemaguard

SchemGuard的应用场景

• 在提交OpenAPI规范更改之前，使用SchemGuard检测潜在的风险。
• 在审查修改API路由的PR时，利用SchemGuard确保API变更的安全性。
• 从代码生成/更新OpenAPI规范后，使用SchemGuard验证变更的正确性。
• 在将API更改部署到生产之前，使用SchemGuard确保向后兼容性。
• 验证迁移是否保持向后兼容性，使用SchemGuard检测破坏性更改。