event-catalog/eventcatalog

event-catalog/eventcatalog – 概述

它是什么 – EventCatalog 是一个源代码可用的文档平台，专门用于描述依赖事件、消息、服务和领域的软件架构。它让团队能够捕获系统的形态（服务、API、模式、业务流程），并通过 Web UI 进行探索。

主要功能

• 架构文档 – 对领域、服务、事件/命令进行建模，并将它们链接在一起。
• AI 驱动的发现 – 内置聊天界面，可以回答关于目录的自然语言问题（例如，“哪些服务发布 OrderCreated 事件？”）。
• 模式浏览器 – 集中查看 OpenAPI、AsyncAPI、Protobuf、JSON-Schema、Avro 等，并支持全文搜索。
• 模式字段搜索 – 在所有模式中查找任何属性，并查看其使用位置。
• 业务流程可视化 – 绘制端到端的工作流图，引用现有的服务和消息。
• 版本控制与治理 – 对事件、命令、服务进行语义化版本控制；破坏性变更检测；面向企业使用的 RBAC/OAuth2。
• 可扩展生成器 – 15+ 个生成器，用于从 AsyncAPI、OpenAPI、Kafka、Confluent、AWS EventBridge 等导入定义。
• 自定义文档 – 将 ADR、runbook、markdown/MDX 文件附加到任何目录实体。

如何开始

npx @eventcatalog/create-eventcatalog@latest my-catalog
# 然后打开 http://localhost:3000

CLI 会搭建一个新的目录，并启动本地 Astro + React 应用。

生态系统

包	作用
@eventcatalog/core	主 Web 应用（Astro + React）
@eventcatalog/sdk	用于编程式目录操作的 Node.js SDK
@eventcatalog/create-eventcatalog	CLI 脚手架工具
@eventcatalog/visualiser	用于嵌入可视化的独立 React 组件

适用对象 – 构建事件驱动或微服务架构的软件团队，需要活的可搜索的真相来源，并希望获得 AI 辅助查询。

链接 – 文档：https://www.eventcatalog.dev/docs • 在线演示：https://demo.eventcatalog.dev • Discord 社区支持。