eventcatalog

项目简介

EventCatalog 是一个用于文档生成的工具，专注于事件驱动架构的可发现性和文档化。随着事件驱动架构的流行，这个工具可以帮助团队记录和理解他们的事件、架构及相关技术细节。

核心功能

文档生成与可视化

• 文档化域、服务和消息：支持记录任意域、服务和信息，甚至示例代码片段。
• 可视化架构：通过直观的方式展示上游和下游服务之间的关系。
• 支持多种格式的架构描述：例如 Avro、JSON 等。
• 自定义 MDX 组件：允许通过 MDX 格式添加和使用自定义组件。
• 内容版本化：可以对文档进行版本管理，并记录变更日志。

可发现性功能

• 搜索与过滤：提供强大的搜索和过滤功能，帮助团队快速找到所需的信息。
• 文档团队和用户：记录团队和用户信息，便于管理和沟通。
• 自动化文档生成：可通过插件架构自动生成文档，支持从 AsyncAPI 或 OpenAPI 文档生成。

问题背景

在采用事件驱动架构时，初期的服务和信息通常可以轻松管理。然而，随着架构的扩展和更多事件的加入，治理变得复杂。许多团队由于缺乏文档和规章体系，最终陷入“复杂性的海洋”。EventCatalog 的出现是为了帮助团队突破这些障碍，更高效地管理和探索事件驱动架构。

解决方案

EventCatalog 提供了一种以 Markdown 为驱动的网站生成器，专注于架构的发现和文档化。它能够记录各种架构组件（如域、服务、消息、架构、代码示例）以及可视化展示服务关系。此外，还支持技术无关的集成，能够与各种事件驱动架构技术和架构格式搭配使用。

开始使用

用户可以通过几分钟的设置开始使用 EventCatalog。以下是启动一个新目录的简单步骤：

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

演示示例

为了更好地展示其功能，EventCatalog 提供了一个零售系统的示例，利用域、服务和消息进行演示。这有助于用户更直观地了解工具的使用与效果。

赞助与支持

EventCatalog 项目得到了多家公司的赞助，如 Hookdeck、Gravitee 和 Oso，致力于提升事件驱动架构的管理和可视化。对于企业用户和开发者，EventCatalog 提供定制支持和优先技术协助等服务，促进企业更好地使用该工具。

招贤纳士

EventCatalog 欢迎各界贡献者的加入，无论是改进代码还是提出建议，我们都乐于接受帮助。使用者可以在项目 GitHub 上找到贡献指南，并提出想法、报告问题或建议功能改善。

许可证

EventCatalog 项目根据 MIT 许可证开源，用户可以自由使用和扩展这个强大的工具来满足其架构管理需求。