API Contract Generator 技能:先定义新接口的请求和响应
EnglishClaude Code 安装步骤
- 从 GitHub 固定提交获取完整的 `plugins/api-development/api-contract-generator/skills/generating-api-contracts` 目录。
- 复制到目标项目的 `.claude/skills/`,确认 `.claude/skills/generating-api-contracts/SKILL.md`,再从项目根目录启动 Claude Code,输入 `/generating-api-contracts`。
中文摘要
用 Claude Code 将业务规则变成 OpenAPI 契约和正反例,先让前后端就字段、状态和边界达成一致。
SKILL.md 中文导读
可复现示例
定义 POST /templates 需要 name,允许可选 description。写 201 的 id/name 响应和空名称的 400 响应,再验证两份示例。工作步骤
- 为创建操作列出必填和可选字段,并定义成功响应及校验错误结构。
- 为每种状态写样例,用项目 validator 核对契约与示例。
验收方法
契约给出成功和失败形状,前端可先用这两份 fixture 开发,后端有明确验收条件。
GitHub 原文 · 更新日期
适用环境
准备自己的 API 提案和 OpenAPI 工具。示例使用合成清单模板资源。
常见问题
可以用一个通用响应体覆盖所有状态吗?
为实际结构不同的状态写独立 schema。把可共用的标准错误字段放在组件定义。
相关指南
相关推荐
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