Versioning APIs 技能:用 OpenAPI 验证旧客户端兼容
EnglishClaude Code 安装步骤
- 从 GitHub 固定提交获取完整的 `plugins/api-development/api-versioning-manager/skills/versioning-apis` 目录。
- 复制到目标项目的 `.claude/skills/`,确认 `.claude/skills/versioning-apis/SKILL.md`,再从项目根目录启动 Claude Code,输入 `/versioning-apis`。
中文摘要
为同一个 API 维护 v1 与 v2 的契约。用 Claude Code 找出破坏性改动、设计兼容适配层,并在两版路由上运行契约测试。
SKILL.md 中文导读
可复现示例
本地目录服务返回 id=7 的商品。令 /v1/items/7 返回 amount: 1000,/v2/items/7 返回 price: {amount: 1000, currency: 'CNY'}。分别用两个契约验证响应,并确认旧版客户端继续读到数值 amount。工作步骤
- 先对照请求、响应与错误格式,标出删字段、改类型和新增必填项。让两版共用同一个业务服务。
- 写两个序列化适配器。为旧版加入保持原格式的契约断言,再核对新版新增字段。
验收方法
v1 仍符合旧版 OpenAPI,v2 额外声明币种。移除 v1 的 amount 会触发回归测试。
GitHub 原文 · 更新日期
适用环境
准备本地 API 项目、旧版响应样本、两份 OpenAPI 定义和测试工具。示例使用路由路径区分 API 版本。
常见问题
字段类型没变,含义变化能从 OpenAPI 差异发现吗?
给业务含义单独加契约断言。例如明确金额单位及舍入方式,记录代表性的输入与输出。
相关指南
相关推荐
groq-install-auth 技能
jeremylongshore/claude-code-plugins-plus-skills
anima-common-errors 技能
jeremylongshore/claude-code-plugins-plus-skills
apple-notes-hello-world 技能
jeremylongshore/claude-code-plugins-plus-skills
castai-hello-world 技能
jeremylongshore/claude-code-plugins-plus-skills
cohere-local-dev-loop 技能
jeremylongshore/claude-code-plugins-plus-skills
figma-security-basics 技能
jeremylongshore/claude-code-plugins-plus-skills