📖 EventCatalog
功能:面向事件驱动架构的文档生成器,支持Markdown驱动,记录域/服务/消息/模式等多种内容,支持内容版本管理,分配所有者,支持模式,OpenAPI,MDX组件等等...
核心功能
- 📃 记录域,服务和消息 (示例)
- 📊 可视化你的架构 (示例)
- ⭐ 支持任何模式格式 (如Avro, JSON) (示例)
- 🗂️ 记录任何代码示例 (任何代码片段)
- 💅 自定义MDX组件 (了解更多)
- 🗄️ 版本域,服务和消息
- ⭐ 可发现性功能 (搜索,过滤等) (示例)
- ⭐ 记录团队和用户 (示例)
- ⭐ 还有更多...
问题
事件驱动架构越来越流行,让我们能够编写解耦的架构,并使用消息在域/团队之间进行通信。
在开始事件驱动架构时,你可能只有少量的服务和消息。随着团队和组织规模的扩大,管理和治理这些内容变得非常困难。
随着时间的推移,更多的事件被添加到我们的域中,需求变化,我们的架构扩展。
随着更多的域,服务或消息加入我们的架构,团队发现和探索这些内容变得非常困难。
许多团队忽视文档和治理,最终陷入了复杂性之海(观看演讲)。
EventCatalog的构建是为了帮助记录你的事件驱动架构,并帮助你的团队探索和理解事件、模式及更多内容。
在这些博客文章和视频中了解更多:
- 介绍EventCatalog v2 (2024)
- 介绍EventCatalog v1 (2022)
- 事件驱动架构:超越模式注册表(博客)
- 复杂性是事件驱动架构的难题(视频)by David Boyne
这个解决方案
将EventCatalog视为一个网站生成器,它允许你使用markdown记录你的事件架构。
EventCatalog专注于发现和记录,允许你:
- 记录域/服务/消息/模式/代码示例等内容
- 使用你的事件直观显示上下游服务之间的关系
- 允许你版本化你的文档,并支持变更日志
- 为域、服务和消息添加所有者,以便你的团队知道谁拥有你的域的哪部分
- 还有更多...
EventCatalog是技术中立的,这意味着你可以将你的目录与任何你选择的EDA技术和任何模式格式集成。
EventCatalog支持插件架构,可以让你从你的系统生成文档。
你可以在网站上了解更多有关它的工作原理
快速开始
你可以在几分钟内设置好,前往我们的文档开始 👇
➡️ 快速开始
或者运行以下命令来构建一个新的目录
npx @eventcatalog/create-eventcatalog@latest my-catalog
演示
这里是一个使用域、服务和消息的零售系统示例。
你可以在GitHub库中的示例下看到生成网站的markdown文件。
企业支持
有兴趣与我们合作吗?我们的产品包括专属支持,优先援助,功能开发,自定义集成等等。
在我们的企业方案中查找更多详情。
寻找v1版本?
还在使用EventCatalog的v1版本?我们推荐升级到最新版本。在迁移指南中了解更多。
贡献
如果你有任何问题,功能或问题,请随时提出任何问题或请求。我们会尽力回复。
你可以在这里找到贡献指南。
贡献者 ✨
感谢这些出色的人们 (emojis key):
Rafael Renan Pacheco
💻 📖
Luis Diego
💻
Daniel Ruf
📖
Fredrik Johansson
💻
Naresh Kumar Reddy Gaddam
💻
Andre Deutmeyer
💻
Pebbz
💻
Alexander Holbreich
📖
José Delgado
💻
jlee-spt
💻
Kim Rejström
💻
Christophe Gabard
💻
Carlo Bertini
💻
David Regla
💻
Marcio Vinicius
💻
Daniel Andres Castillo Ardila
💻
Baerten Dennis
💻
Ryan Cormack
💻
Nathan Birrell
💻
Jack Tomlinson
💻
Carlos Rodrigues
💻
该项目遵循 all-contributors 规范。欢迎任何形式的贡献!
赞助
使用 EventCatalog 并想要回馈?我们非常感谢您的支持。
您可以在我们的网站上找到更多详情。
许可证
MIT.