API Design Principles:给 REST 和 GraphQL 接口定一套能落地的规范

API Design Principles 是 wpank 发布在 ClawHub 的 API 设计评审与规范 Skill,当前版本 1.0.0,分类 dev-programming,经 SkillHub 收录,无需 API Key。它把资源命名、HTTP 方法与状态码、分页、错误响应、版本化与限流等 REST 设计约定,以及 GraphQL 的 Schema 结构、Relay 分页、DataLoader 与查询保护整理成可直接执行的规范,并提供 REST 与 GraphQL 的选型决策框架。适合设计新接口、实现前评审规范、为团队制定 API 标准、重构旧接口或在范式间迁移的开发者与接口负责人。典型用法是把接口需求或现有定义交给 Skill 逐项检查,产出改写建议和团队规范文档。注意它输出的是约定而非工程工具,示例中的深度上限、复杂度上限和限流阈值需按业务实测调整。

阅读全文