SuperAPI AI 工具集

api-patterns

编程与开发

查看项目

更新于 10-16 06:15

技能介绍

用途:该技能聚焦 API 设计原则与决策过程,强调根据具体场景思考,而非套用固定模板。同时提供选择性阅读规则:只阅读与当前请求相关的文件,先查看内容地图再定位所需内容。

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

使用方式:设计 API 前可参考其决策清单,确认是否了解 API 消费方、是否为本场景选定 API 风格、是否定义一致的响应格式、是否规划版本策略、是否考虑认证需求、是否规划限流、是否确定文档方案。脚本方面提供 scripts/api_validator.py,命令为 python scripts/api_validator.py <project_path>,用于 API 端点校验。

适用场景:需要做 API 风格选型、响应结构设计、版本演进规划、认证与限流方案选择、文档编写或安全审计的工程团队。

限制:资料未提供具体收费、价格、平台支持范围与实际效果数据;相关实现可参考 backend-development,数据结构参考 database-design,安全细节参考 security-hardening。