用途：这是一份 API 设计规范与指南，面向需要设计与维护接口的开发者，目标是做出可预测、一致、简单、可演化且文档完善的 API。资料强调 API 是开发者的用户界面，应以设计 UI 的同等用心来设计。
主要能力：给出 RESTful 设计的完整要点，包括 Richardson 成熟度模型（从单一端点到 HATEOAS 的四个层级）、资源命名（名词、复数、层级关系、kebab-case）、HTTP 方法与幂等性/安全性对照表、状态码分类（2XX/4XX/5XX 具体语义）、请求与响应结构、分页（offset 与 cursor 两种模式）、过滤、排序。同时覆盖 API 版本化策略（URL 路径、查询参数、请求头、内容协商）、版本生命周期（Alpha/Beta/Stable/Sunset）以及破坏性与非破坏性变更的区分。GraphQL 部分包含类型定义、连接式分页、Query、Mutation 与错误载荷设计。此外还涉及安全（Token、API Key、OAuth 2.0 流程、速率限制头与 429 响应、输入校验与净化）、文档（OpenAPI/Swagger、HATEOAS 自描述链接）与错误处理（统一错误结构与命名约定）。
使用方式：资料为规范参考，未提供安装命令或运行代码；可直接作为设计评审清单使用，末尾附有 API 设计检查表，以及 REST 与 GraphQL 的选型建议。
适用场景：为 Web、移动端或服务间接口制定 REST 或 GraphQL 设计规范、评审接口一致性、规划版本升级与弃用。
限制：资料未说明任何平台绑定、收费、价格或工具集成方式，相关事实暂未提供。