Claude Code API 合同技能|约定前后端分页请求与响应
EnglishClaude Code 安装步骤
- 从固定版本 GitHub 工作副本获取完整的 `plugins/community/sprint/skills/api-contract` 目录。
- 将目录放入目标项目的 `.claude/skills/`,确认 `.claude/skills/api-contract/SKILL.md` 存在,再从项目根目录启动 Claude Code 并输入 `/api-contract`。
中文摘要
给前后端写一份共享接口合同,明确分页参数、响应类型、空列表语义和请求错误。
SKILL.md 中文导读
可复现示例
为 `GET /books` 写合同。约定 `page` 与 `limit`,用同一响应结构描述查到一项、没有匹配项及错误输入。工作步骤
- 写清路由、方法、参数类型、默认值及上限,再定义 TypeScript 响应结构。
- 用一页有效数据、一个空页及无效参数分别核对响应约定。前后端按同一份合同实现。
验收方法
交付内容应包含有数据和空列表的成功示例,以及单独的错误响应。前后端可直接据此写测试。
GitHub 原文 · 更新日期
适用环境
准备同一项功能的页面和 API 需求。示例可在临时项目中起草一份 Markdown 合同。
常见问题
响应类型需要描述每个字段如何从数据库获取吗?
合同记录调用方可见的字段与约束。数据库查询实现可放在服务设计中。
相关指南
相关推荐
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