SuperAPI AI 工具集

api-design

编程与开发

查看项目

更新于 10-16 02:35

技能介绍

用途:面向 API 设计与需求梳理,强调 API-First:在写代码或用户故事之前先设计 OpenAPI 规范。默认协议为 HTTP RESTful,除非另行指定 gRPC 或 EDA。

主要能力与格式:

  • OpenAPI 规范:定义路径、操作 ID、参数与响应,如 /users/{userId} 的 GET 及 200/404 响应。
  • 用户故事:采用 As [用户角色], I want [目标], So that [价值] 格式。
  • 验收标准:采用 Gherkin 的 Scenario/Given/When/Then 结构。
  • 流程可视化:使用 Mermaid sequenceDiagram 描述客户端、API、服务与数据库的交互。
  • 决策树:需要 API 设计先写 OpenAPI 规范;需要用户故事用固定格式;需要测试用例用 Given/When/Then;需要流程图用 Mermaid。
  • 成功度量:涵盖业务(ROI、用户采用)、性能(延迟、吞吐)、基础设施(错误率、可用性)以及 SLIs/SLOs。

使用方式:按上述格式产出规范、故事、验收标准与序列图,作为开发前的设计依据。

限制:资料未提供安装命令、依赖、平台、收费或具体实施步骤,暂未提供。