SuperAPI AI 工具集

designing-apis

编程与开发

查看项目

更新于 10-16 09:53

技能介绍

用途:用于设计结构良好、可扩展的 API,涵盖 REST、GraphQL、WebSocket、消息队列等风格的选型与规范,适合新建 API、制定团队 API 标准、处理版本与破坏性变更、定义错误格式、分页与限流、OAuth2 或 API Key 鉴权,以及编写 OpenAPI/AsyncAPI 规格。

主要能力:资源导向的 REST 设计(名词化 URL、关系嵌套不超过 2-3 层);HTTP 方法与幂等性语义;状态码使用;协议选择决策矩阵(公开 API 与 CRUD 偏向 REST,复杂查询偏向 GraphQL,实时双向偏向 WebSocket,事件驱动微服务偏向消息队列);版本策略(推荐 URL 路径版本,另有 Header、媒体类型等方式)及弃用时间线与 Deprecation/Sunset 头;RFC 7807 Problem Details 错误格式;分页策略(小数据用 offset,大数据用 cursor,排序数据用 keyset,实时流用 cursor);Token Bucket 限流及 X-RateLimit-* 头与 429、Retry-After;OAuth2 授权码与客户端凭证流程、基于 scope 的授权、API Key 管理;OpenAPI 3.1 与 AsyncAPI 3.0 规范结构;GraphQL schema 设计与 DataLoader 解决 N+1。

使用方式:技能内含参考文档(如 references/rest-design.md、pagination-patterns.md、rate-limiting.md、authentication.md 等)与 examples/openapi、examples/asyncapi、examples/graphql 示例,并提供 scripts/validate-openapi.sh 校验 OpenAPI 规格。具体安装与调用步骤资料中暂未提供。

适用场景:API 架构评审、标准制定、版本迁移规划、错误与分页规范、鉴权流程设计。

限制:该技能不覆盖实现代码、鉴权落地实现、API 测试策略与部署基础设施,这些分别由 api-patterns、auth-security、testing-strategies、deploying-applications 等技能处理。