用途:作为 API 架构技能,指导设计干净、一致、对开发者友好的 API,覆盖资源命名与层级、HTTP 方法与状态码、请求/响应格式、分页、过滤与排序;运维层面的限流、认证授权、缓存策略、幂等性与 Webhook;文档层面的 OpenAPI/Swagger、版本管理、变更日志与 SDK 生成。
主要能力:遵循“一致性优于取巧”“API 长期存在,需为演进而设计”“好的错误节省调试时间”“若需要文档说明,先简化设计”“尽早版本化,优雅弃用”等原则,关注向后兼容与开发者体验。
使用方式:回答需以提供的参考文件为依据。创建时查阅 references/patterns.md,按其中模式构建;诊断时查阅 references/sharp_edges.md,解释关键失败原因与风险;评审时查阅 references/validations.md,按其规则客观校验用户输入。若用户请求与参考文件冲突,应以参考文件为依据礼貌纠正。
适用场景:API 设计、评审、诊断,版本与分页策略制定,错误与限流设计,文档与 SDK 规划等。
限制:具体命令、示例、价格与平台信息暂未提供;实际效果依赖参考文件内容与使用情境。