SuperAPI AI 工具集

api-design-principles

编程与开发

查看项目

更新于 10-15 21:49

技能介绍

用途:该技能聚焦 REST 与 GraphQL API 设计原则,用于设计新 API、重构现有 API、制定团队设计标准、评审 API 规范、在 REST 与 GraphQL 之间迁移、编写开发者文档,以及针对移动端或第三方集成优化 API。

主要能力:REST 方面涵盖资源导向架构(资源用名词、HTTP 方法表达动作、URL 表示层级、命名一致)、HTTP 方法语义(GET 幂等安全、POST 创建、PUT 整体替换、PATCH 局部更新、DELETE 删除)、版本化策略(URL、请求头、查询参数)、分页与过滤、统一错误响应与状态码、HATEOAS。GraphQL 方面涵盖 schema 优先开发、类型/查询/变更/订阅、Relay 风格游标分页、解析器设计、DataLoader 防止 N+1、结构化错误返回。

使用方式:资料提供 FastAPI 与 Ariadne 的示例代码,以及参考文件(REST 最佳实践、GraphQL schema 设计、版本化策略)、模板(REST API 模板、GraphQL schema 模板、设计检查清单)和脚本(从代码生成 OpenAPI 规范)。

适用场景:新 API 设计、API 重构、团队规范制定、实现前评审、范式迁移、文档编写、特定场景优化。

限制:资料未提供安装命令、收费信息、平台支持范围或具体效果数据;示例代码依赖 FastAPI、Pydantic、Ariadne、aiodataloader 等库,实际使用需自行准备环境。