SuperAPI AI 工具集

dev-api-design

编程与开发

查看项目

更新于 10-15 23:25

技能介绍

用途:这是一个契约优先的 API 设计技能,覆盖 REST、GraphQL、gRPC、tRPC、AsyncAPI 以及面向智能体(MCP 工具层)的接口。它负责契约选型、鉴权边界、版本化、错误、分页、限流、幂等性与校验;不替代后端实现或安全评审。

主要能力:

  • 依据决策表选择 API 风格:REST+OpenAPI(公开 API、工具链兼容、可缓存资源)、GraphQL(客户端驱动的复杂查询、多团队 schema 归属)、gRPC(内部服务、双向流、类型关键边界)、tRPC(TypeScript 单体仓库共享服务端与客户端)、AsyncAPI+Webhook(事件驱动契约、发布订阅、推送通知)、MCP 工具层(智能体或 LLM 是主要消费者)。
  • 产出规范契约工件:OpenAPI 3.x、GraphQL SDL、protobuf、TypeScript 类型、AsyncAPI 3.x、MCP 工具 schema。
  • 契约评审清单:规范工件、兼容与版本化模型、废弃时间线与 Deprecation/Sunset 头、错误模型(REST/HTTP 用 RFC 9457 Problem Details)、鉴权边界、分页(高基数用游标)、限流(IETF RateLimit 字段或 X-RateLimit-* 三元组,429 带 Retry-After)、幂等性、长任务(202+Location)、Webhook 的 HMAC 签名与重放防护与 trace_id、CI 中的破坏性变更检测(oasdiff)、契约测试(Schemathesis、Pact)。
  • 版本化策略表:URL 路径版本(公开 API)、请求头版本(内部 API)、内容协商、演进式(GraphQL、gRPC)。
  • 按变更类别给出兼容性证据:形状变更、无形状变化但语义变更、默认值/顺序/配额/超时变更、移除或收窄。
  • 提供参考资料:REST 设计模式、OpenAPI 指南、GraphQL/gRPC/tRPC/AsyncAPI 模式、Webhook 模式、实时 API 模式、错误处理、鉴权、分页过滤、限流、API 测试、LLM 智能体 API 契约。
  • 提供模板与资产:openapi-template.yaml、spectral-ruleset.yaml、oasdiff-ci.yml 及跨平台模板。

必要用法(工作流):先按决策表选择 API 风格;定义规范契约工件;运行契约评审清单;加入契约校验、破坏性变更检测与文档;交付规范、示例与发布说明。

限制:不负责后端实现(归 software-backend)、AppSec 评审与鉴权加固(归 software-security-appsec)、系统级架构(归 software-architecture-design)、发布与迁移排序(归 dev-workflow-planning)。规范修订与 RFC 状态需自行在 IETF datatracker 与 modelcontextprotocol.io 查询当前版本;不要仅凭 schema 差异推断兼容或部署顺序。具体收费、价格与平台支持暂未提供。