SuperAPI AI 工具集

api-design-principles

编程与开发

查看项目

更新于 10-16 04:55

技能介绍

用途:该技能用于指导设计新的 REST 或 GraphQL API、重构已有 API 提升可用性、制定团队 API 设计标准、在实现前评审接口规格、在 REST 与 GraphQL 等范式间迁移、编写面向开发者的 API 文档,以及针对移动端或第三方集成等场景优化 API。

主要能力:REST 方面强调面向资源的架构,资源用名词、动作用 HTTP 方法,GET/POST/PUT/PATCH/DELETE 各有语义,URL 表示资源层级;给出资源集合端点、分页与过滤、错误处理与状态码、HATEOAS 等设计模式,并提供 OpenAPI/Swagger 文档、限流、版本化(URL、请求头、查询参数三种策略)等实践。GraphQL 方面强调模式优先,用类型定义领域模型,查询读取、变更修改、订阅实时更新,客户端按需取数、单一端点、强类型模式、内置内省;给出模式设计、解析器设计、DataLoader 防止 N+1,以及 Relay 风格游标分页、枚举与自定义标量、输入与载荷类型、结构化错误等模式。

使用方式:资料以概念讲解加代码模式呈现,包含 FastAPI REST 端点、分页响应、统一错误响应、HATEOAS 响应、GraphQL 模式与解析器、DataLoader 批量加载等示例;并列出参考文档(REST 最佳实践、GraphQL 模式设计、版本策略)、模板(REST API 模板、GraphQL 模式模板、设计检查清单)与脚本(从代码生成 OpenAPI 规格)。具体安装命令、调用命令与运行方式暂未提供。

适用场景与限制:适合后端与 API 设计者、团队规范制定者和接口评审者。资料指出常见陷阱包括 REST 过度或不足取数、破坏性变更、错误格式不一致、缺少限流、文档缺失、忽视 HTTP 语义、API 结构紧贴数据库模式,以及 GraphQL 的 N+1 问题;并建议始终分页、正确使用状态码、从第一天规划版本化。该技能的收费、价格与平台信息暂未提供。