Repolode
event-catalog

event-catalog/eventcatalog

面向软件架构的文档工具,用于整理领域、服务、事件、消息和Schema,供团队与AI代理查阅。

Star
2,946
Fork
281
未关闭 Issue
79
最近提交
4小时前

这是什么?

EventCatalog 是一个面向软件架构的文档工具。团队可以把领域、服务、事件、命令、消息和 Schema 记录为带版本的结构化资源,并生成可浏览的网站,通过可视化组件查看各部分之间的关系。

目录既可以手动维护,也可以从 AsyncAPI、OpenAPI、Protobuf、JSON Schema、Avro 等规范生成,还支持从 Kafka、Confluent、AWS EventBridge 等事件平台导入。团队还能为领域和服务附加架构决策记录、运行手册和自定义 MDX 页面,并用业务流程串联已有的消息和服务。

项目内置 AI 问答和 MCP 服务器,方便人和工具用自然语言查询架构目录。它以 @eventcatalog/core 应用、Node.js SDK、脚手架 CLI 和独立可视化组件的形式提供。代码采用 Business Source License 1.1 协议公开源码,生态包使用 MIT 协议。

核心功能

  • 01将领域、服务、事件、命令和消息记录为带版本的资源。
  • 02支持从 AsyncAPI、OpenAPI、Protobuf、JSON Schema、Avro 以及 Kafka、AWS EventBridge 等事件平台生成目录内容。
  • 03提供可搜索的 Schema 浏览器,并支持按字段在整个目录中查找。
  • 04内置架构可视化和业务流程文档功能。
  • 05提供 AI 问答和 MCP 服务器,便于查询目录。

适用场景

  • 为事件驱动或微服务架构编写文档,让团队查清每条消息由哪些服务发布和消费。
  • 在众多服务之间统一管理 Schema 定义及其使用位置。
  • 通过 MCP 让 AI 助手结构化地访问架构目录。
  • 将架构决策记录和运行手册与其所描述的服务放在一起发布。

快速上手

  1. 1

    使用创建工具生成新的目录项目

    npx @eventcatalog/create-eventcatalog@latest my-catalog
  2. 2

    在浏览器中打开 localhost:3000 上的目录

使用前须知

  • 许可证为 BSL 1.1 的源码可用许可,并非 OSI 认证的开源许可证。
  • 元数据中的许可证信息不明确(NOASSERTION),需要自行确认。

收录于专题

标签

常见问题

eventcatalog 是什么?
面向软件架构的文档工具,用于整理领域、服务、事件、消息和Schema,供团队与AI代理查阅。 EventCatalog 是一个面向软件架构的文档工具。团队可以把领域、服务、事件、命令、消息和 Schema 记录为带版本的结构化资源,并生成可浏览的网站,通过可视化组件查看各部分之间的关系。
eventcatalog 可以免费使用吗?用的什么许可证?
eventcatalog 以 Other 许可证开源。用于商业产品前,请先确认许可证条款。
eventcatalog 还在维护吗?
活跃维护中。eventcatalog 最近一次提交是在 2026年10月23日。
eventcatalog 适合用来做什么?
为事件驱动或微服务架构编写文档,让团队查清每条消息由哪些服务发布和消费。 在众多服务之间统一管理 Schema 定义及其使用位置。 通过 MCP 让 AI 助手结构化地访问架构目录。 将架构决策记录和运行手册与其所描述的服务放在一起发布。
eventcatalog 怎么安装和运行?
使用创建工具生成新的目录项目: npx @eventcatalog/create-eventcatalog@latest my-catalog 在浏览器中打开 localhost:3000 上的目录
在哪里获取 eventcatalog?
源代码和安装说明在 GitHub 上:https://github.com/event-catalog/eventcatalog

概要由 AI 根据项目 README 生成;GitHub 数据每日更新。

相关项目