SuperAPI AI 工具集

api-patterns

编程与开发

查看项目

更新于 10-16 05:45

技能介绍

用途:这是一份 API 设计原则与决策参考技能,面向 2025 年的 API 设计实践,核心目标是帮助使用者“思考”而非照搬固定模式。它按需分文件组织内容,使用时建议只阅读与当前请求相关的文件,先查看内容地图再定位所需资料。

主要能力(按文件划分):api-style.md 提供 REST 与 GraphQL、tRPC 的决策树,用于选择 API 类型;rest.md 涵盖资源命名、HTTP 方法与状态码;response.md 涉及信封模式、错误格式与分页;graphql.md 讨论 schema 设计、适用场景与安全;trpc.md 面向 TypeScript monorepo 与类型安全;versioning.md 覆盖 URI、Header、Query 三种版本化方式;auth.md 比较 JWT、OAuth、Passkey、API Keys 等认证模式;rate-limiting.md 介绍令牌桶与滑动窗口;documentation.md 提供 OpenAPI/Swagger 最佳实践;security-testing.md 对应 OWASP API Top 10 与认证授权测试。

使用方式:提供决策检查清单,设计前确认是否询问过 API 消费方、是否针对当前场景选择风格、是否定义一致的响应格式、是否规划版本策略、是否考虑认证与限流、是否确定文档方案。另提供脚本 scripts/api_validator.py,可用 python scripts/api_validator.py <project_path> 校验 API 端点。

适用场景:需要做 API 选型、设计 REST 接口、规划响应结构与版本演进、评估认证与限流方案,或进行 API 安全审计时。

限制与说明:资料未提供收费、价格、平台兼容范围与效果数据,暂未提供;内容为原则性指导,实际实现需结合相关技能,如后端开发、数据库设计与安全加固。