SuperAPI AI 工具集

api-patterns

编程与开发

查看项目

更新于 10-15 19:57

技能介绍

用途:这是一套面向 API 设计的决策型技能,强调“思考而非照搬固定模式”,用于在具体场景下选择 API 风格并规划响应结构、版本演进、认证与限流等设计要素。

主要能力:按内容地图组织多个主题文件,包括 api-style.md(REST vs GraphQL vs tRPC 决策树)、rest.md(资源命名、HTTP 方法、状态码)、response.md(信封模式、错误格式、分页)、graphql.md(Schema 设计、适用场景与安全)、trpc.md(TypeScript monorepo 与类型安全)、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 消费方、是否为本场景选定风格、是否定义一致的响应格式、是否规划版本策略、是否考虑认证与限流、是否确定文档方案。附带脚本 scripts/api_validator.py,用于 API 端点校验,命令为 python scripts/api_validator.py <project_path>。

适用场景:需要为项目选择 API 风格、设计 REST 资源与状态码、规划分页与错误响应、制定版本演进策略、选择认证方式或做 API 安全审计时。

限制:资料未提供具体实现代码、收费、价格、平台支持或效果数据;该技能侧重设计决策与规范,实际 API 实现需结合后端开发、数据库设计与安全加固等相关技能。