無料ツール
Structurizr DSL を C4 モデル図に変換
Structurizr DSL のワークスペースやワークスペース JSON のエクスポートを貼り付けると、C4 モデルのビューを編集できる図として表示します。人物、ソフトウェアシステム、コンテナー、コンポーネント、デプロイメントノードを描き、関係には説明がラベルとして付きます。ビューを 1 つ選ぶことも、すべてを別々の図として開くこともできます。
出力例
使い方
ワークスペースを貼り付けるかドロップ
workspace.dsl ファイル、Structurizr のプレイグラウンドからコピーした DSL、または Structurizr がエクスポートした JSON。model と views のブロックを読み取り、styles は残したままで構いません。
各 C4 ビューを確認
システムランドスケープからコンポーネント、デプロイメントまで、ワークスペースのビューがすべて一覧に並びます。1 つ選ぶと、プレビューが C4 カード、境界、ラベル付きの矢印で描き直されます。
Archboard で開く
ビューを新しい図として保存し、並べ替え、注釈の追加、リンクの共有、SVG や PNG へのエクスポートができます。登録には Google または GitHub のアカウントを使います。
Structurizr ワークスペースから描かれるもの
選んだビューは、モデルの次の部分から作られます。
person人物は説明付きの C4 人物カードになります。External タグを持つ人物や、JSON エクスポートで location External の人物は外部の人物になります。
softwareSystemソフトウェアシステムは説明付きの C4 システムカードになります。External タグを持つシステムは、名前だけを表示する外部システムカードになります。
containerコンテナーは技術と説明付きのカードになります。Database タグを持つコンテナーは、名前だけを表示するデータベースカードになります。Queue タグのコンテナー、External タグのコンテナーとコンポーネント、enterprise ブロックは、それぞれ専用の C4 タイプ(queue コンテナー、external container / component カード、enterprise 境界)で描かれます。
componentコンポーネントは技術付きのカードとして、所属するコンテナーの中に描かれます。
->関係は説明をラベルにした矢印になり、技術は角かっこで続きます。ビューに親だけが表示される場合、子どうしの関係は親どうしの間に 1 本だけ描かれます。
container bankingcomponent banking.apiコンテナービューとコンポーネントビューの対象は枠になります。コンテナービューではソフトウェアシステム、コンポーネントビューではコンテナーです。
groupグループは、含まれる人物、システム、コンテナーを囲む枠になります。空のグループは描かれません。
deploymentNodeinfrastructureNodecontainerInstanceデプロイメントビューでは、入れ子のデプロイメントノードが枠に、コンテナーやソフトウェアシステムのインスタンスが元の要素のカードに、インフラストラクチャノードがデプロイメントノードのカードになります。
systemLandscapesystemContextdeploymentシステムランドスケープ、システムコンテキスト、コンテナー、コンポーネント、デプロイメントの各ビューを、それぞれ別の図として描きます。ビューのないワークスペースには、ランドスケープ 1 つ、システムごとのコンテキストビュー、コンテナーを持つシステムごとのコンテナービューを用意します。
autoLayout lrinclude *ビューの種類ごとの意味に沿った include *、識別子を並べた include と exclude、そして autoLayout の向き。向きの指定がなければ上から下です。
1 つのワークスペースに複数のビュー
ワークスペースには、同じモデルのビューがいくつも入っているのが普通です。ファイルの最初のビューがまず描かれ、プレビュー上のビュー選択で同じテキストの別のビューに切り替えられます。すべてのビューを残すには、すべてのビューを開く を使うと、選んだビューを先頭に、ビューごとに 1 つの図がワークスペースに作成されます。Free プランで図の上限に収まらないビューも黙って捨てられることはなく、開いた数と残りの数が表示されます。
Structurizr のインポートで扱わないもの
- ワークスペースが参照するファイルやスクリプト。!include、!docs、!adrs、!script、!plugin、workspace extends は追跡も実行もしません。警告に件数が表示され、貼り付けたテキストに書かれた内容はすべて描かれます。
- 要素や関係のスタイル、テーマ、ブランディング。形、色、アイコンは C4 カードのものになり、図を Archboard で開いた後で変更できます。
- dynamic、filtered、custom、image の各ビューと、式で書いた include や exclude のルール。これらはスキップして件数を数え、その他のビューは一覧に残ります。
- JSON エクスポートに保存された要素の位置。Structurizr のサイズは C4 カードと合わないため、各ビューは自動で配置し直します。
- ドキュメントのセクション、意思決定の記録、properties、perspectives、URL。読み取るのはモデルとビューだけです。
Structurizr に関する質問
Structurizr DSL からどの C4 レベルを描けますか?
Structurizr がモデル化する範囲はすべてです。レベル 1 はシステムコンテキストとシステムランドスケープのビュー、レベル 2 はコンテナービュー、レベル 3 はコンポーネントビューで、さらにデプロイメントビューも描けます。コードレベルの図は Structurizr のワークスペースに含まれないため、描く対象がありません。
DSL の代わりにワークスペース JSON のエクスポートを貼り付けられますか?
はい。Structurizr が保存またはエクスポートする JSON も同じように読み取ります。各ビューに並ぶ要素と関係を描き、人物、システム、コンテナー、デプロイメントノードも含みます。保存された位置は使わず、各ビューを新たに自動配置します。
すべてのビューを一度に開けますか?
はい。ワークスペースにビューが 2 つ以上あれば、すべてのビューを開く で、選んだビューから順にビューごとの図を作成します。プランの図の上限で途中で止まった場合も、開いたビューはそのまま残り、残りの数が表示されるので、知らないうちに失われることはありません。
ワークスペースで !include を使っています。どうすればよいですか?
取り込んでいるファイルを、!include の行の代わりに同じテキストボックスに貼り付けてください。このツールは渡されたテキストだけを読むため、ディレクティブは追跡せず、警告に件数が表示されます。
Archboard で開くと何が保存されますか?
プレビューは保存されません。Archboard で開く を選ぶと、表示中のビューが C4 カード、境界、枠、ラベル付きの矢印とともに、ワークスペースの新しい図として保存されます。後で DSL や JSON を変えても、その図は更新されません。
Structurizr を図にするこのツールは無料ですか?
はい。ワークスペースの貼り付けと図の表示にアカウントは要りません。ビューを 1 つ、またはすべて Archboard で開くには無料アカウントが必要です。