Repolode
yuzutech

yuzutech/kroki

PlantUML, Mermaid, D2, GraphViz 등의 텍스트 기반 다이어그램 소스를 SVG, PNG 및 기타 이미지로 변환하는 통합 HTTP API입니다.

스타
4,374
포크
323
열린 이슈
142
마지막 커밋
어제

어떤 프로젝트인가요?

Kroki는 단일 HTTP API를 통해 텍스트 기반 다이어그램 설명을 이미지로 변환하는 게이트웨이입니다. 도구마다 별도의 렌더러를 설치하는 대신, 하나의 엔드포인트에 다이어그램 소스를 보내고 PlantUML, Mermaid, Graphviz, Ditaa, Excalidraw, Vega-Lite 등의 다이어그램 유형과 원하는 출력 형식을 지정하면 됩니다.

서버는 Vert.x 기반 Java로 작성되었으며 Docker 이미지로 실행됩니다. URL 인코딩된 GET 요청, JSON POST 본문 또는 Accept 헤더를 지정한 일반 텍스트로 요청을 보낼 수 있습니다. Mermaid, BPMN, Excalidraw, diagrams.net을 비롯한 일부 렌더러는 별도의 컨테이너로 실행되며, 메인 서버는 환경 변수를 통해 이들 컨테이너에 연결합니다.

이 프로젝트는 UML, C4, ERD, DBML, BPMN, 시퀀스 및 네트워크 다이어그램, 타이밍 및 패킷 다이어그램, bytefield 레이아웃 등 다양한 다이어그램 유형을 지원합니다. 각 다이어그램 도구를 로컬에 설치하지 않아도 생성된 이미지를 문서나 웹 페이지에 삽입할 수 있습니다.

핵심 기능

  • 01다양한 다이어그램 언어를 위한 통합 API
  • 02인코딩된 소스를 포함한 GET 요청, JSON POST 또는 일반 텍스트 입력 지원
  • 03SVG, PNG 및 기타 이미지 형식으로 출력
  • 04Docker 이미지로 실행되며 Mermaid, BPMN, Excalidraw용 보조 컨테이너를 선택적으로 사용 가능
  • 05환경 변수를 통해 보조 서비스 연결을 설정 가능

활용 사례

  • 문서화 파이프라인에서 아키텍처 또는 시퀀스 다이어그램 렌더링
  • 텍스트 소스를 바탕으로 위키나 채팅 도구에 넣을 다이어그램 이미지 생성
  • 팀 내부에서 사용할 비공개 다이어그램 렌더링 서비스 호스팅
  • 로컬에 도구를 설치하지 않고 웹 애플리케이션에 다이어그램 미리보기 삽입

빠른 시작

  1. 1

    Docker로 Kroki 컨테이너를 실행합니다

    docker run -d -p 8000:8000 yuzutech/kroki
  2. 2

    필요한 경우 docker-compose를 사용해 Mermaid, BPMN, Excalidraw 또는 diagrams.net용 컴패니언 컨테이너를 시작합니다

    docker-compose up -d

사용 전 알아둘 점

  • Mermaid, BPMN, Excalidraw와 같은 일부 다이어그램 유형은 추가 컴패니언 컨테이너를 시작해야 합니다.
  • diagrams.net 연동은 실험 단계입니다.

토픽

자주 묻는 질문

kroki은(는) 무엇인가요?
PlantUML, Mermaid, D2, GraphViz 등의 텍스트 기반 다이어그램 소스를 SVG, PNG 및 기타 이미지로 변환하는 통합 HTTP API입니다. Kroki는 단일 HTTP API를 통해 텍스트 기반 다이어그램 설명을 이미지로 변환하는 게이트웨이입니다. 도구마다 별도의 렌더러를 설치하는 대신, 하나의 엔드포인트에 다이어그램 소스를 보내고 PlantUML, Mermaid, Graphviz, Ditaa, Excalidraw, Vega-Lite 등의 다이어그램 유형과 원하는 출력 형식을 지정하면 됩니다.
kroki은(는) 무료로 사용할 수 있나요? 라이선스는 무엇인가요?
kroki은(는) MIT 라이선스의 오픈소스입니다. 상업용 제품에 사용하기 전에 라이선스 조건을 확인하세요.
kroki은(는) 아직 유지보수되고 있나요?
활발히 유지보수 중. kroki의 마지막 커밋은 2026년 10월 20일입니다.
kroki은(는) 어디에 사용할 수 있나요?
문서화 파이프라인에서 아키텍처 또는 시퀀스 다이어그램 렌더링 텍스트 소스를 바탕으로 위키나 채팅 도구에 넣을 다이어그램 이미지 생성 팀 내부에서 사용할 비공개 다이어그램 렌더링 서비스 호스팅 로컬에 도구를 설치하지 않고 웹 애플리케이션에 다이어그램 미리보기 삽입
kroki는 어떻게 설치하나요?
Docker로 Kroki 컨테이너를 실행합니다: docker run -d -p 8000:8000 yuzutech/kroki 필요한 경우 docker-compose를 사용해 Mermaid, BPMN, Excalidraw 또는 diagrams.net용 컴패니언 컨테이너를 시작합니다: docker-compose up -d
kroki은(는) 어디서 받을 수 있나요?
소스 코드와 설치 방법은 GitHub에 있습니다: https://github.com/yuzutech/kroki

요약은 프로젝트 README를 바탕으로 AI가 작성했습니다. GitHub 통계는 매일 갱신됩니다.

관련 프로젝트