SuperAPI AI 工具集

awesome-api-design

编程与开发

查看项目

更新于 10-15 23:45

技能介绍

用途:在编码前设计或评审 HTTP API 的契约形态,让消费者能长期依赖而不遭遇破坏性变更。适用于“为 X 设计 API”“评审该 API 设计/OpenAPI 规范”“如何做版本、分页、重试”等请求,也用于新增端点需匹配既有约定时。不负责错误信封字段与重试分类,也不做已实现处理器的安全审计。

主要能力:先盘点既有约定与项目术语,保持同一 API 内一致优先于通用最佳实践;按资源而非过程建模,动作作为状态转换,嵌套最多一层,更深层级改为查询过滤;在 v1 发布前定好演进规则,附加式变更原地进行,破坏性变更只开新版本,弃用需公告日落窗口;列表端点用不透明游标分页,过滤排序为索引字段的命名参数白名单;不安全方法支持 Idempotency-Key,同键同体重放响应,同键不同体返回 409;可冲突更新用 ETag + If-Match 乐观并发,声明 PATCH 语义并拒绝空 PATCH;以 OpenAPI/模式文档作为事实来源,ID 不透明带前缀,时间戳 ISO 8601 UTC,金额用最小货币单位整数,枚举封闭并记录未知值默认处理。

使用方式:按工作流程产出契约决策、规范骨架或差异、与既有约定的偏离及理由、待决问题(各带推荐默认值)。评审时按检查清单逐项给出发现。变更评审需并排阅读新旧形态与两侧代码,走四个场景:旧写新读、新写旧读、回滚、静态载荷,并双向搜索消费者,最终给出兼容、依赖顺序、破坏性、无法判定四种结论之一。

限制:资料未提供具体安装命令、收费、价格或平台信息;不定义错误信封字段与重试分类,也不审计已实现处理器的漏洞。