kroki

Кроки предоставляет унифицированный API при поддержке Blockdiag (Blockdiag, Seqdiag, Actdiag, Nwdiag, Packetdiag, Rackdiag), BPMN, Bytefield, C4 (с Plantuml), D2, DBML, Diagrams.net (экспериментальный Graphviz, Mermaid, Nomnoml, Pikchr, Plantuml, Svgbob, Symbolator, Umlet, Vega, Vega-Lite, Wavedrom и Wireviz ... и больше!

QuickStart

В этом разделе предлагается базовое руководство для оценки Кроки. Более полные инструкции по установке находятся в документации Kroki.

Использование

Кроки использует простой алгоритм (дефлят + base64), чтобы кодировать вашу диаграмму в URL:

GET /plantuml/svg/SyfFKj2rKt3CoKnELR1Io4ZDoSa70000

Вы также можете позвонить Кроки с POST :

 ПОЧТА / 

{
  "diagram_source" : " Bob -> Alice : hello " ,
  "diagram_type" : " plantuml " ,
  "output_format" : " svg "
}

В этом случае вам не нужно кодировать свою диаграмму.

Также можно отправить вашу диаграмму в виде простого текста, используя заголовок Content-Type . Выходной формат будет указан с использованием заголовка Accept , а источник диаграммы будет отправлен в качестве корпуса запроса:

 Post /plantuml 

 Accept: image/svg+xml
Content-Type: text/plain

Bob -> Alice : hello

Вы также можете определить выходной формат в URL -адресе, если не хотите добавлять заголовок Accept :

 Post /plantuml /svg 

 Content-Type: text/plain

Bob -> Alice : hello

Та же концепция применяется при отправке диаграммы как JSON:

 Post /plantuml /svg 

{
  "diagram_source" : " Bob -> Alice : hello "
}

Планировка проекта

Кроки имеет модульную архитектуру:

сервер

Веб -сервер Java (питание от Vert.x ), который действует как шлюз. Croki Server создан с использованием Maven.

Умлет

Крошечный Java API на вершине Умлета (MINI) для генерации диаграмм.

nomnoml

Node.js cli на вершине библиотеки диаграмм nomnoml .

вега

Node.js cli на вершине библиотеки диаграмм Vega . Также поддерживает лаконичную грамматику Vega-Lite.

русалка

Сопутствующий веб -сервер, написанный в JavaScript (питается на микро ), который предоставляет библиотеку диаграмм русалки .

BPMN

Сопутствующий веб-сервер, написанный в JavaScript (питается на микро ), который предоставляет библиотеку диаграмм BPMN-JS .

Байтфилд

Node.js cli на вершине библиотеки диаграмм Bytefield-SVG .

волны

Node.js cli на вершине библиотеки диаграммы WaveDrom .

Экклидрау

Спутниковый веб -сервер, написанный в JavaScript (питается на микро ), который обеспечивает Excalidraw .

Diagrams.net

Сопутствующий веб -сервер, написанный в JavaScript (питается на микро ), который предоставляет Diagrams.net .

Строить

Сервер шлюза

Первый шаг - создать проект с помощью Maven:

 $ Make Builderver

Docker Images

Чтобы построить все изображения Docker, используйте следующую команду:

 $ sudo Make BuldDockerimages 

Примечание

sudo может не понадобиться в зависимости от вашего распределения и конфигурации docker .

Бегать

Как только изображения Docker будут созданы, вы можете запустить Kroki с помощью docker :

 $ docker run -d -p 8000: 8000 yuzutech/kroki

Компаньон -контейнеры

Если вы хотите использовать одну из следующих библиотек схемы, вам также нужно будет запустить соответствующий контейнер сопутствующего сопутствующего:

Yuzutech/Kroki-Mermaid

Русалка

Yuzutech/Kroki-Bpmn

BPMN

Yuzutech/Kroki-Excalidraw

Экклидрау

Yuzutech/Kroki-Diagramsnet (экспериментальный)

Diagrams.net

Вы можете использовать docker-compose для запуска нескольких контейнеров:

Docker-Compose.yml

 services :
  core :
    image : yuzutech/kroki
    environment :
      - KROKI_MERMAID_HOST=mermaid
      - KROKI_BPMN_HOST=bpmn
      - KROKI_EXCALIDRAW_HOST=excalidraw
    ports :
      - " 8000:8000 "
  mermaid :
    image : yuzutech/kroki-mermaid
    expose :
      - " 8002 "
  bpmn :
    image : yuzutech/kroki-bpmn
    expose :
      - " 8003 "
  excalidraw :
    image : yuzutech/kroki-excalidraw
    expose :
      - " 8004 "
  # experimental!
  diagramsnet :
    image : yuzutech/kroki-diagramsnet
    expose :
      - " 8005 "

 $ docker -compose -d