用途:为设计一致、对开发者友好的 REST API 提供约定与最佳实践,适用于设计新端点、审查现有 API 契约、添加分页/过滤/排序、实现错误处理、规划版本策略以及构建公开或合作方 API。
主要能力:资源设计方面,URL 使用复数名词、小写、kebab-case,子资源表达关系,非 CRUD 动作用动词且克制;命名上避免 URL 中出现动词、单数或 snake_case。HTTP 方法语义区分幂等与安全,状态码按语义使用(200/201/204、400/401/403/404/409/422/429、500/502/503),创建返回 201 并带 Location 头。响应格式提供 data 包裹与扁平两种方案,集合响应含 meta 与 links,错误响应含 code、message 与字段级 details。分页支持 offset 与 cursor 两种,并给出适用场景。过滤支持比较运算符、多值与点号嵌套字段,排序用 - 前缀降序,支持全文搜索与稀疏字段集。认证支持 Bearer Token 与 API Key,授权含资源级与角色级模式。限流提供响应头与 429 处理,并列出分层限流表。版本控制推荐 URL 路径版本,给出弃用时间线与破坏性/非破坏性变更区分。另附 TypeScript、Python、Go 实现模式与上线前检查清单。
使用方式:作为技能在 Claude Code 中按需激活,用于生成或审查 API 设计;具体安装命令与调用方式暂未提供。
限制:资料未说明收费、价格、平台支持范围与效果保证;示例代码仅作模式参考,需结合具体技术栈调整。