eventcatalog
專為軟體架構設計的文件平台。為您的團隊與 AI 代理,記錄領域、服務、事件與綱要。
eventcatalog 是什麼?
專為軟體架構設計的文件平台。為您的團隊與 AI 代理,記錄領域、服務、事件與綱要。
eventcatalog 概覽
這是什麼
EventCatalog 是一款原始碼可取得的軟體架構文件工具,專為記錄系統、領域、服務、訊息與綱要而設計,而非一般通用頁面。它幫助團隊與 AI 代理理解並瀏覽架構。核心應用採用 Business Source License 1.1,生態套件則使用 MIT 授權。該專案報告已建立超過 40,000 個目錄。
主要功能
- 記錄架構中的領域、服務與訊息。
- AI 驅動探索:內建 AI 聊天與 MCP 伺服器,可用自然語言查詢目錄。
- 綱要瀏覽器:可搜尋的檢視,支援 OpenAPI、AsyncAPI、Protobuf、JSON Schema、Avro 等綱要格式。
- 綱要欄位:篩選並尋找目錄中所有欄位的屬性,顯示其在服務與訊息中的使用情況。
- 自帶文件:將架構決策記錄、操作手冊與自訂文件附加至領域、服務與團隊,並支援版本管理。
- 記錄業務流程:引用現有服務與訊息,建立端到端的工作流程描述。
- 其他功能:資源的完整語意版本管理、15 個以上產生器(AsyncAPI、OpenAPI、Kafka、Confluent、AWS EventBridge 等)、可自訂主題與 MDX 元件,以及企業級功能如 OAuth2、RBAC、綱要治理與破壞性變更偵測。
使用情境
EventCatalog 適用於需要記錄與視覺化軟體架構(包括領域、服務、事件與綱要)的團隊。它可作為架構知識的單一事實來源,支援 AI 輔助的系統元件探索,以及業務流程文件化。適用於電子商務、金融、醫療保健與 SaaS 等產業。
快速開始
bash npx @eventcatalog/create-eventcatalog@latest my-catalog 然後開啟 http://localhost:3000 開始記錄。如需逐步引導,請參閱儲存庫 README。
授權與價格
EventCatalog 核心應用(5.0.0 版及之後版本)採用 Business Source License 1.1。營收低於 1000 萬美元且資金低於 1000 萬美元的組織可免費使用;否則需訂閱。4.x 及之前版本仍使用 MIT 授權。生態套件(SDK、CLI、連接器、diff、linter、visualiser、breaking-changes、create-eventcatalog)採用 MIT 授權。
內容整理自該專案公開的 README 與儲存庫資訊。