DSH Plugins
返回列表
⚙️

dsh-api-contract

工作流 更新于 2026.08.25

在终端中运行以下命令:

dsh plugin install uckkk/dsh-api-contract

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

在 DeepSeek Harness 终端中执行 dsh plugin install uckkk/dsh-api-contract 即可安装该插件,源码仓库为 https://github.com/uckkk/dsh-api-contract 。

插件介绍

OpenAPI 规范是团队里最常被引用、也最容易悄悄腐坏的那份文档:一个路径被改、一个参数从可选变必填、一个响应字段悄然消失,下游客户端还在按旧契约发请求,直到深夜某个 500 才暴露问题。dsh-api-contract 把这件事变成一条本地命令:解析你的 OpenAPI 3.x 规范(JSON 或 YAML),直接生成 TypeScript(基于 fetch)或 Python(基于 requests)的完整类型化客户端,省掉手写接口定义和类型注释放逐字对齐的重复劳动。

它还提供了 diff_spec 工具,对比两个版本的规范并逐项分类:破坏性变更(删除路径或方法、移除必填参数、参数类型变化、移除 2xx 响应、响应结构变化)与非破坏性变更,让你在一次代码审查中就能识别出真正影响下游的回归。整个流程纯 Node 实现,无网络请求、无外部服务,规范文件始终留在本地。

适合维护多语言客户端的团队,或者正打算把 OpenAPI 作为唯一真源来驱动开发工作流的人。它缩短从规范到可运行代码的距离,也在每次发布前加了一道低成本的回归检查。

使用场景

  • 发布前对比两版 OpenAPI 规范,快速定位破坏性变更
  • 从 OpenAPI 规范一键生成 TypeScript fetch 客户端,省去手写接口定义
  • 从 OpenAPI 规范生成 Python requests 客户端,保持类型与规范同步

适合人员

  • 维护多语言 API 客户端的后端或全栈团队
  • 以 OpenAPI 为唯一真源驱动开发的平台工程团队
  • 希望在代码审查中快速识别 API 契约回归的独立开发者