AsyncAPI 事件目录构建器
将以下提示词粘贴到你的 AI 对话框中:
请根据 https://skillhub.cn/install/skillhub.md 的指引,将规范名为 @user_3c6cb52e/asyncapi-event-catalog-builder 的技能安装到你的 AI 助手中。
技能介绍
解决什么问题
事件驱动架构的接口文档通常散落在各处:Kafka 的 topic 定义在某个服务的代码里,RabbitMQ 的队列和绑定写在配置中心,消息格式一改,文档就先失了真。等到下游团队问"某个事件谁生产、字段有哪些"时,往往只能靠翻代码或口头确认。这个技能要消灭的就是这种状态:只要仓库里有一份符合 AsyncAPI 3.0 的规范文件,就能自动产出一份结构化的事件目录,让通道、消息 schema 与服务器绑定沉淀为单一事实源。
工作原理
技能的核心是调用 AsyncAPI 生态的 parser-js(@asyncapi/parser)解析规范文档,分三步完成目录构建:
- 提取通道:遍历规范中的
channels,每个通道代表一个事件流通的端点; - 还原消息 schema:从消息的
payload中提取消息体的数据结构,供订阅方核对字段; - 读取服务器绑定:解析 Kafka 与 RabbitMQ 的
bindings,还原 broker 侧的接入配置,如 topic 名称、队列与交换机等。
最终输出一份人类可读的事件驱动架构文档,可直接入库或挂到内部文档站,供消息生产者与消费者共同查阅。
适用边界
- 输入必须已是 AsyncAPI 3.0 规范文件,技能不会从业务代码反推事件模型,也不做代码扫描;
- 目前仅覆盖 Kafka 与 RabbitMQ 两种绑定,其他 broker 或协议(如 MQTT、Google Pub/Sub)不在提取范围内;
- 官方提示无法自动获取源码级安装方式或使用说明,若要在生产或敏感流水线中使用,建议先审阅上游 AsyncAPI 项目(
asyncapi.com)及官方文档(asyncapi.com/docs),确认解析行为与版本兼容性后再接入。
使用场景
- 团队已维护一份 AsyncAPI 3.0 规范,需要产出可入库、供上下游共同查阅的事件目录文档。
- 下游服务准备接入 Kafka 事件,需要先确认各 topic 对应的消息字段与数据结构。
- 需要把 RabbitMQ 中队列、交换机与绑定关系梳理成一份可读的事件拓扑清单。
- 规范文件已覆盖多个通道,需要快速生成结构统一、无需手动排版的架构文档。
适合人员
- 维护事件驱动架构的后端工程师,需要让事件文档与 AsyncAPI 规范保持一致。
- 接入 Kafka 事件的下游服务开发者,需要先确认消息字段才能开始对接。
- 负责梳理 RabbitMQ 消息拓扑的中间件工程师,需要一份清晰的绑定关系清单。
- 编写 AsyncAPI 规范的架构师,需要快速生成可分享的事件目录而非逐条排版。