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, 스키마, 비즈니스 흐름)를 포착하고 웹 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 메인 웹 애플리케이션 (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 커뮤니티(지원).

관련

  • 프로젝트
  • 프로젝트
  • 프로젝트
  • 프로젝트
  • 프로젝트