event-catalog/eventcatalog

Documentation tool built for software architecture. Document your domains, services, events and schemas — for your teams and your AI agents.

event-catalog/eventcatalog – 概要

これは何か – EventCatalog は、イベント、メッセージ、サービス、ドメインに依存するソフトウェアアーキテクチャを説明するために特別に構築された、ソース利用可能なドキュメントプラットフォームです。チームはシステムの形状(サービス、API、スキーマ、ビジネスフロー)を捉え、Web UI を通じて探索できます。

主な機能

  • アーキテクチャ文書化 – ドメイン、サービス、イベント/コマンドをモデル化し、それらをリンクします。
  • AI を活用した発見 – カタログに関する自然言語の質問に答えることができる組み込みのチャットインターフェース(例:「OrderCreated イベントを公開するサービスはどれですか?」)。
  • スキーマエクスプローラー – OpenAPI、AsyncAPI、Protobuf、JSON-Schema、Avro などの集中ビュー。全文検索対応。
  • スキーマフィールド検索 – すべてのスキーマから任意のプロパティを検索し、その使用場所を確認します。
  • ビジネスフロー可視化 – 既存のサービスとメッセージを参照するエンドツーエンドのワークフロー図を作成します。
  • バージョニングとガバナンス – イベント、コマンド、サービスのセマンティックバージョニング、破壊的変更の検出、エンタープライズ向け RBAC/OAuth2。
  • 拡張可能なジェネレーター – AsyncAPI、OpenAPI、Kafka、Confluent、AWS EventBridge などから定義をインポートするための 15 以上のジェネレーター。
  • カスタムドキュメント – ADR、ランブック、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 コミュニティ(サポート用)。

関連

  • プロジェクト
  • プロジェクト
  • プロジェクト
  • プロジェクト
  • プロジェクト