DSH Plugins
返回列表
⚙️

dsh-api-contract

工作流 更新于 2026.10.29

在终端中运行以下命令:

dsh plugin install JOJO-Adam/dsh-api-contract

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

在 DeepSeek Harness 中执行 dsh plugin install JOJO-Adam/dsh-api-contract,即可从 https://github.com/JOJO-Adam/dsh-api-contract 安装本插件。

插件介绍

团队和 agent 一起定接口时,常见困境是文档写到一半才发现命名、分页或错误码各说各话,改一个字段又不知道会不会把老客户端打挂。dsh-api-contract 把「接口这一层」收成可复核的流程:先落契约、再谈实现,变更用同一套标准评审,而不是让 AI 随手写一篇接口说明。

插件覆盖从开新接口到演进的全链路。开新接口时会一次性厘清资源边界、命名、分页、错误、鉴权、幂等与版本等必须早定的要素;写或审 OpenAPI 时强调资源导向路径、components 复用,并点出那些容易悄悄变成破坏性变更的反模式。判破坏性变更时会按类型说明客户端具体坏在哪,包括「未知字段」这类常被忽略的兼容例外;同时帮你定错误契约(状态码与业务码分工)以及版本与四步弃用流程,文档与示例也从契约出发分层把关。

它只管契约、演进与文档,不替你们选框架、也不写可直接上线的服务端代码;变更检测以你提供的契约文件为准,没有契约时第一步就是补契约。适合前后端、平台或 API 负责人在设计、评审和改接口时,需要和 agent 对齐「能落地、能校验、改之前能算清影响」的团队。

使用场景

  • 从零设计订单、用户等资源接口,先把边界与约定定死再写实现
  • 评审或改写 OpenAPI,排查路径设计与 components 里隐藏的兼容风险
  • 改字段或枚举前,判断会不会伤老客户端并理清错误码与版本策略

适合人员

  • 负责对外或对内 API 的后端与平台工程师
  • 需要统一错误码、分页与鉴权约定的技术负责人
  • 用 agent 协作写文档但希望契约可校验的产品或架构同学