1. 製品
  2.   ダイアグラム
  3.   Java
  4.   Kroki

Kroki

 
 

テキストから図を作成するオープンソースの Java API

ソフトウェア開発者がテキスト記述からダイアグラムを作成できるようにする無料の Java ライブラリ。ブロック図、シーケンス図、アクティビティ図、ネットワーク図などをサポートします。

Kroki は、ソフトウェア開発者が Java アプリ内でテキスト記述からダイアグラムを作成できるようにする、MIT ライセンスのオープンソース統合 Java API です。これは、どこでも使用できるすべてのダイアグラム ライブラリ用の非常に安定した統合 API です。ライブラリはモジュラー アーキテクチャに従っており、ゲートウェイとして機能する Java Web サーバー、ダイアグラムを生成する Umlet Java API、Node.js CLI などのさまざまなモジュールを提供しています。

ライブラリは、ブロック ダイアグラム、BPMN、バイトフィールド、シーケンス ダイアグラム、アクティビティ ダイアグラム、ネットワーク ダイアグラム、パケット ダイアグラム、RackDiag、C4 (PlantUML を使用)、Ditaa、Erd、GraphViz、Mermaid、Nomnoml、PlantUML、SvgBob、UMLet、WaveDrom など、いくつかの重要なダイアグラム タイプをサポートしています。ライブラリは、PNG、SVG、JPEG、PDF、Base64 などの形式にエクスポートできます。

ライブラリは、優れたパフォーマンスと速度を提供します。任意の HTTP クライアントを使用してライブラリと簡単にやり取りできます。テキストの説明からダイアグラムを作成するための HTTP API を提供し、GET リクエストと POST リクエストの両方を処理できます。ダイアグラムのエンコード機能をサポートし、GET リクエストで deflate + base64 アルゴリズムを使用できます。

Previous Next

Kroki を使い始める

Kroki をインストールするには、Docker を使用することをお勧めします。スムーズにインストールするには、次のコマンドを使用してください。

Docker を使用して Kroki をインストールする

docker run yuzutech/kroki

Kroki git リポジトリをクローンする

git clone https://github.com/yuzutech/kroki.git

Java API によるブロック ダイアグラムの作成

ブロック ダイアグラムは、エンジニアリングで使用される非常に特殊な高レベルのフローチャートを表します。主要な部分または機能がブロックで表され、線で相互接続されてブロックの関係が示されます。オープン ソースの Kroki ライブラリを使用すると、ソフトウェア開発者は Java コマンドを使用して独自のアプリケーション内でブロック ダイアグラムを作成できます。既存のダイアグラムを簡単に変更することもできます。

Java で新しいブロック ダイアグラムを作成する

blockdiag {
  blockdiag -> generates -> "block-diagrams";
  blockdiag -> is -> "very easy!";

  blockdiag [color = "greenyellow"];
  "block-diagrams" [color = "pink"];
  "very easy!" [color = "orange"];
}

シーケンス図の作成

オープンソースの Java ライブラリ Kroki を使用すると、ソフトウェア開発者は独自のアプリケーション内でシーケンス図を作成および管理できます。ライブラリを使用すると、図に新しい要素を簡単に追加し、作成した要素を自動的に配置できます。ライブラリはアクティビティのフローを簡単に制御し、アクティビティのタイトルを簡単に挿入または更新したり、アクティビティを削除したり、アクティブを再配置したりする機能をユーザーに提供します。

Java API 経由で新しいシーケンス図を作成する

seqdiag {
  browser  -> webserver [label = "GET /index.html"];
  browser <-- webserver;
  browser  -> webserver [label = "POST /blog/comment"];
  webserver  -> database [label = "INSERT comment"];
  webserver <-- database;
  browser <-- webserver;
}

Java 経由でダイアグラムを SVG または PDF にエクスポート

Kroki ライブラリを使用すると、ソフトウェア開発者は Java アプリケーション内でさまざまな種類のダイアグラムを作成できます。ライブラリは、ダイアグラムを作成する際に優れたパフォーマンスと速度を提供します。作成したダイアグラムは、PNG、SVG、PDF、JPEG など、サポートされているいくつかのファイル形式にエクスポートできます。Accept ヘッダーを使用して出力形式を指定するか、URL で出力形式を定義することもできます。

 日本