Repolode
Предложить
yuzutech

yuzutech/kroki

Единый HTTP API для преобразования текстовых описаний диаграмм, например PlantUML, Mermaid, D2 и GraphViz, в SVG, PNG и другие изображения.

Открыть на GitHubСайт
Звёзды
4,374
Форки
323
Открытые issues
142
Последний коммит
вчера

Что это?

Kroki — это шлюз, который преобразует текстовые описания диаграмм в изображения через единый HTTP API. Вместо установки отдельного рендерера для каждого инструмента достаточно отправить исходный текст диаграммы на один эндпоинт и указать её тип — например, PlantUML, Mermaid, Graphviz, Ditaa, Excalidraw или Vega-Lite — и нужный формат вывода.

Сервер написан на Java с использованием Vert.x и запускается как Docker-образ. Запросы можно отправлять методом GET с URL-кодированием, в теле JSON-запроса POST или как обычный текст с заголовками Accept. Некоторые рендереры, в том числе Mermaid, BPMN, Excalidraw и diagrams.net, запускаются в дополнительных контейнерах, к которым основной сервер подключается через переменные окружения.

Проект поддерживает множество типов диаграмм: UML, C4, ERD, DBML, BPMN, диаграммы последовательностей и сетей, диаграммы времени и пакетов, а также схемы bytefield. Сгенерированные изображения можно встраивать в документацию или веб-страницы, не устанавливая каждый инструмент для работы с диаграммами локально.

Ключевые возможности

  • 01Единый API для множества языков описания диаграмм
  • 02Принимает GET-запросы с закодированным исходным текстом, JSON в POST-запросах или обычный текст
  • 03Выводит изображения в форматах SVG, PNG и других
  • 04Запускается как Docker-образ; для Mermaid, BPMN и Excalidraw можно использовать дополнительные контейнеры
  • 05Подключения к дополнительным сервисам настраиваются через переменные окружения

Сценарии использования

  • Рендеринг архитектурных диаграмм и диаграмм последовательностей в конвейерах документации
  • Создание изображений диаграмм из текстовых описаний для вики или чатов
  • Развёртывание собственного сервиса рендеринга диаграмм для внутренней команды
  • Встраивание предварительных просмотров диаграмм в веб-приложения без локальной установки инструментов

Быстрый старт

  1. 1

    Запустите контейнер Kroki с помощью Docker

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

    При необходимости запустите дополнительные контейнеры для Mermaid, BPMN, Excalidraw или diagrams.net с помощью docker-compose

    docker-compose up -d

Что важно знать

  • Для некоторых типов диаграмм, например Mermaid, BPMN и Excalidraw, необходимо запустить дополнительные контейнеры.
  • Интеграция с diagrams.net является экспериментальной.

Темы

#diagrams#plantuml#mermaid#graphviz#uml#svg#docker#api#blockdiag#bpmn

Частые вопросы

Что такое kroki?
Единый HTTP API для преобразования текстовых описаний диаграмм, например PlantUML, Mermaid, D2 и GraphViz, в SVG, PNG и другие изображения. Kroki — это шлюз, который преобразует текстовые описания диаграмм в изображения через единый HTTP API. Вместо установки отдельного рендерера для каждого инструмента достаточно отправить исходный текст диаграммы на один эндпоинт и указать её тип — например, PlantUML, Mermaid, Graphviz, Ditaa, Excalidraw или Vega-Lite — и нужный формат вывода.
kroki можно использовать бесплатно? Какая у него лицензия?
kroki распространяется с открытым исходным кодом под лицензией MIT. Перед использованием в коммерческих продуктах проверьте условия лицензии.
kroki всё ещё поддерживается?
Активно поддерживается. Последний коммит в kroki — 20 окт. 2026 г..
Для чего можно использовать kroki?
Рендеринг архитектурных диаграмм и диаграмм последовательностей в конвейерах документации Создание изображений диаграмм из текстовых описаний для вики или чатов Развёртывание собственного сервиса рендеринга диаграмм для внутренней команды Встраивание предварительных просмотров диаграмм в веб-приложения без локальной установки инструментов
Как установить kroki?
Запустите контейнер Kroki с помощью Docker: docker run -d -p 8000:8000 yuzutech/kroki При необходимости запустите дополнительные контейнеры для Mermaid, BPMN, Excalidraw или diagrams.net с помощью docker-compose: docker-compose up -d
Где скачать kroki?
Исходный код и инструкции по установке — на GitHub: https://github.com/yuzutech/kroki

Описание создано ИИ на основе README проекта. Статистика GitHub обновляется ежедневно.

Похожие проекты

cathrynlavery / diagram-design

Навык для агентских инструментов, который создаёт редакционные диаграммы в одном автономном HTML-файле с SVG и поддерживает 45 типов диаграмм и оформление в стиле бренда.

Продуктивность и приложения#agent-skills#diagrams#svg
58,9 тыс.3,8 тыс.HTMLMITОбновлён вчера