SuperAPI AI 工具集

api-architect

编程与开发

查看项目

更新于 10-15 20:29

技能介绍

用途:该技能定位为 API 架构设计助手,覆盖 REST、GraphQL、gRPC 和 WebSocket,适合在设计接口契约、选择架构范式、编写规范与规划版本时使用。触发关键词包括 API design、REST API、GraphQL schema、gRPC service、OpenAPI、Swagger、API versioning、endpoint design、rate limiting、OAuth flow、API gateway。明确不适用:数据库模式交由 data-pipeline-engineer,前端消费交由 web-design-expert,部署交由 devops-automator。

主要能力:一是 API-First 流程,先定义契约再生成桩代码、实现并按规范测试;二是范式选择,REST 用于 CRUD,GraphQL 用于灵活查询,gRPC 用于内部服务;三是规范编写,REST 用 OpenAPI 3.1,GraphQL 用 SDL,gRPC 用 .proto;四是统一响应信封,成功返回 data 与 meta,错误返回 code、message 与 details 字段级问题;五是版本化策略,支持 URL、Header、Query 三种方式;六是安全与开发体验,涵盖 OAuth 2.0、JWT、API Keys、RBAC、Swagger UI、SDK 生成与沙箱。参考文件包含 OpenAPI 3.1、GraphQL Relay 连接、全流式 Protocol Buffer、分层限流与安全配置示例。

使用方式:先定义契约,再选择范式并编写规范,随后设计一致的错误响应,最后在首次发布前规划版本。可运行 ./scripts/validate-api-spec.sh 校验 OpenAPI 的版本、安全方案与 operationId,校验 GraphQL 的 Query 类型、分页与错误处理,校验 Protocol Buffer 的语法、包名与字段编号,并检查硬编码 URL、缺失版本化等常见问题。可用工具包括 Read、Write、Edit 以及 Bash(npm:)、Bash(npx:)、Bash(openapi-generator:*) 等用于规范检查与代码生成。

注意事项:资料列出十类常见反模式,包括动词式 URL、响应信封不一致、未版本化的破坏性变更、GraphQL 的 N+1、过度获取、缺失分页、缺少幂等键、泄露内部错误、缺少 CORS 配置和没有限流,并给出对应修复方向。输出物可包括 OpenAPI 规范、GraphQL 模式、Protocol Buffer 定义、API 文档、SDK 示例和 Postman 集合。收费、价格与具体平台信息暂未提供。