Claude Code api-contract-design:将需求转换成 TypeScript 接口契约
EnglishClaude Code 安装步骤
- 打开 GitHub 固定提交的 `.claude/skills/api-contract-design/SKILL.md`,核对内容与使用条件。
- 在自己的项目中创建 `.claude/skills/api-contract-design/`,把核对后的文件保存为 `.claude/skills/api-contract-design/SKILL.md`。
- 在该项目根目录启动 Claude Code,在斜杠菜单中选择 `/api-contract-design`。
中文摘要
用结构化 JSON 描述领域类型、接口、组件属性和服务签名,方便不同实现方对照。
SKILL.md 中文导读
可复现示例
样例 contract-19 的工作坊资源包含 {entity: 'Workshop', titleType: 'string', idType: 'string'}。已确认首版只做契约评审。工作步骤
- 从业务名词和数据关系提取显式类型,核对允许的操作。
- 输出机器可读的接口草稿,供实现方复查字段、请求和响应。
验收方法
契约提出 {type: 'Workshop', title: 'string', id: 'string'},把时间字段和资源 CRUD 请求响应列入评审,确保没有模糊类型。
GitHub 原文 · 更新日期
适用环境
在 Claude Code 中准备明确的领域对象、允许操作、关系和约束。该技能产出契约草稿,需与实际授权范围一起评审。
常见问题
能直接从类型名称推断每个业务字段吗?
先从已确认的需求核对字段与关系。结构化契约可列出建议,尚无依据的业务约束留待评审。