Claude Code api-designer:设计列表接口、分页和错误响应
EnglishClaude Code 安装步骤
- 打开 GitHub 固定提交的 `.claude/skills/api-designer/SKILL.md`,核对内容与使用条件。
- 在自己的项目中创建 `.claude/skills/api-designer/`,把核对后的文件保存为 `.claude/skills/api-designer/SKILL.md`。
- 在该项目根目录启动 Claude Code,在斜杠菜单中选择 `/api-designer`。
中文摘要
给 REST 服务梳理资源命名、分页方式和返回状态,输出同一结构的错误说明与 OpenAPI 参考内容。
SKILL.md 中文导读
可复现示例
接口样例 list-27 的活动列表按近期更新倒序,数据持续新增。为界面返回首屏 12 条,且允许继续读取下一页。工作步骤
- 确定资源名、输出形状及客户端翻页需求。
- 用已知输入对照状态码、条数和下一页参数,写入接口说明。
验收方法
接口可设计为“GET /api/events?limit=12”。结果记录 {status: 200, returned: 12, has_more: true},并返回 next_cursor 供下一页复用。
GitHub 原文 · 更新日期
适用环境
在 Claude Code 中打开已有 API 规范或准备需建模的资源,确认响应字段和数据访问方式。
常见问题
何时应使用偏移量分页?
数据量较小、较少发生变化且需要页码时可采用偏移量分页。频繁发生变动的列表可优先用游标。