DSH Plugins
返回列表
🧩

dsh-openapi-diff

admin-security 更新于 2026.11.01

在终端中运行以下命令:

dsh plugin install lengrufeng2008/dsh-openapi-diff

将以下提示词粘贴到 DeepSeek Harness 对话框中:

在 DeepSeek Harness 中执行 dsh plugin install lengrufeng2008/dsh-openapi-diff 即可安装本插件(源码:https://github.com/lengrufeng2008/dsh-openapi-diff)。

插件介绍

API 演进时,一份 OpenAPI 文档的小改动就可能让现有客户端或网关对接失败。手工对比两份 JSON 既慢又容易漏掉「某字段突然必填」「响应类型变了」这类结构性破坏。本插件在 DSH 里提供针对 OpenAPI JSON 的结构化破坏性变更检查,把常见 breaking 模式系统化地扫出来。

核心能力覆盖:路径或 HTTP 方法被删除、参数/模型属性/响应定义被移除、新增必填字段、可选参数变为必填,以及类型变更等。它只做 JSON 层面的结构子集比对,不展开完整的 $ref 解析,也不深入 oneOf/allOf 语义;因此它是发布前或 CI 里的快速护栏,而不是行为兼容性或契约测试的替代品。

适合维护 REST/OpenAPI 规范的后端、平台或网关团队,以及在合并或发版前需要一眼看清「这份 spec 会不会绊倒下游」的工程师。需要明确的是:没有报破坏并不等于完全兼容,仍应结合业务测试与契约验证做最终判断。

使用场景

  • 发版前对比新旧 OpenAPI JSON,确认是否存在破坏性结构变更
  • 在 CI 中接入,合并 spec 变更时自动拦截 breaking 改动
  • 网关或平台团队评审对外 API 文档变更时的快速检查

适合人员

  • 维护 OpenAPI/REST 规范的后端工程师
  • 负责 API 网关或开放平台的技术团队
  • 需要在流水线里做 spec 变更门禁的 DevOps/平台同学