SuperAPI AI 工具集

api-service-contracts

编程与开发

查看项目

更新于 10-16 00:31

技能介绍

用途:分析项目并记录所有服务、API 端点、同步/异步通信模式、DTO 以及重试/熔断策略,生成展示主要请求流的 Mermaid 时序图,保存到 .github/modernize/assessment/engines/facts/api-service-contracts.md。

主要能力:生成服务目录(服务名、端口、类别、用途、框架依赖);API 端点清单(HTTP 方法、路径、请求/响应类型、版本方案);管理与可观测性端点(Actuator、健康检查、自定义指标);DTO 与契约(网关级 DTO 与服务级实体、不可变性、序列化、OpenAPI/protobuf/GraphQL);通信模式(REST/gRPC、消息队列、熔断/重试/超时、服务发现、网关聚合、安全态势);服务技术矩阵;Mermaid 时序图。

使用方式:输入可选 workspace-path,默认当前目录。支持 Java、.NET、JavaScript、TypeScript 项目。时序图须遵守 Mermaid 安全约束:仅用 sequenceDiagram,参与者用 participant Id as "Label",块用 end 闭合,别名与消息中禁止换行及特定字符,并在代码块前输出 <!-- mermaid-checked: ... --> 注释。

适用场景:多模块构建、Docker Compose、Kubernetes/Helm/IaC 项目的 API 与通信契约梳理。

限制:不支持的项目类型输出错误;未找到端点输出错误;信息不足时生成尽力而为的文档并加注说明;超过 30 个端点按服务分组,时序图控制在 40 个参与者/消息以内。其他细节暂未提供。