SuperAPI AI 工具集

asyncapi-generator

编程与开发

查看项目

更新于 10-16 03:14

技能介绍

用途:当服务代码库没有 AsyncAPI 规范时,用 ripwire 静态分析生成 AsyncAPI 3.x YAML,作为 asyncapi-parser 和 Drift 的输入。它是 oas-generator 的异步对应物,难点在于消息拓扑分散在生产者调用、消费者装饰器、配置文件和环境变量中。

主要能力:识别 broker 与语言;查找所有发送/接收点并区分方向(send/receive);解析 channel 地址并标注 x-address-source(literal、constant、config、inferred、unresolved);构建操作清单;提取消息 payload 与 headers;组装带 $ref 的 AsyncAPI YAML;校验并输出报告。

使用方式:前置条件是 ripwire 在 PATH 中。步骤包括:用 ripwire 识别 broker;用 references/broker-patterns.md 中的模式查找发送/接收点;解析 channel 地址;构建操作清单;提取 payload;组装 YAML;用 asyncapi validate 校验,默认保存到 <service-root>/asyncapi-generated.yaml。

适用场景:为缺少规范的消息服务生成 AsyncAPI 3.x,供 Drift 测试使用。

限制:AsyncAPI 2.x 不受 Drift 支持,必须输出 asyncapi: "3.0.0"。规范可能不完整,含 stub payload 和 unresolved 地址,需人工修复。方向由代码推断,需复核。测试和 mock 代码可能产生误报,应排除。ripwire 返回 over_ceiling=1 时需缩小根目录。未提供收费、价格、平台等信息。