SuperAPI AI 工具集

api-design-expert

编程与开发

查看项目

更新于 10-16 03:17

技能介绍

用途:为 API 设计提供专家级指导,涵盖 RESTful 原则、GraphQL、版本控制策略与 API 最佳实践。当用户提到 REST、GraphQL、API 版本控制或 API 设计时使用。

主要能力:讲解 RESTful 架构(资源导向、统一接口、无状态、可缓存、分层系统);对比 REST、GraphQL、RPC、WebSocket、SSE、gRPC 等 API 风格;覆盖版本控制、认证授权、限流、错误处理、文档与向后兼容等关键考量。

使用方式:资料以 FastAPI 示例展示 REST 端点设计(列表、获取、创建、更新、删除、嵌套资源)、URL 路径/请求头/内容协商三种版本控制、统一错误响应、基于 Redis 的令牌桶限流、HATEOAS 链接、JWT 与 API Key 认证。示例中 JWT 密钥从环境变量 JWT_SECRET_KEY 读取,缺失即失败。

适用场景:设计或评审 REST/GraphQL 接口、制定版本策略、统一错误与限流方案、补充 API 文档与安全实践。

限制:资料未提供该技能的安装命令、收费方式、平台支持或具体使用步骤;示例代码为演示性质,未给出完整可运行实现。反模式清单提醒避免用 GET 做状态变更、响应格式不一致、无版本策略、错误信息差、无限流、暴露内部实现、无版本破坏性变更。