UmlKit 8.6.4

UmlKit

Генерация UML/ER-диаграмм из EF Core DbContext в форматах PlantUML, Mermaid, текстовом и Draw.io.

Установка

dotnet add package UmlKit

API-справочник (класс UmlGenerator)

ToPlantUml(DbContext dbContext)

Генерирует диаграмму классов в формате PlantUML. Включает метки кардинальности (1:N, 1:1) на связях, а также маркеры PK/FK для свойств.

string plantUml = UmlGenerator.ToPlantUml(context);
File.WriteAllText("diagram.puml", plantUml);

ToMermaid(DbContext dbContext)

Генерирует ER-диаграмму в формате Mermaid. Включает метки кардинальности (1:N, 1:1) с использованием нотации Mermaid ER (||--|| для 1:1, ||--o{ для 1:N).

string mermaid = UmlGenerator.ToMermaid(context);
File.WriteAllText("diagram.md", mermaid);

ToText(DbContext dbContext)

Генерирует простую текстовую ER-диаграмму. Каждая сущность выводится с перечислением полей, типов и маркеров PK/FK.

string text = UmlGenerator.ToText(context);
Console.WriteLine(text);

ToDrawIo(DbContext dbContext)

Генерирует ER-диаграмму в формате Draw.io (.drawio XML). Файл можно открыть в diagrams.net / draw.io. Таблицы отображаются с выделением PK-полей и связями между сущностями.

string drawIo = UmlGenerator.ToDrawIo(context);
File.WriteAllText("diagram.drawio", drawIo);

SaveDrawIo(DbContext dbContext, string filePath)

Сохраняет ER-диаграмму в .drawio файл по указанному пути.

UmlGenerator.SaveDrawIo(context, "er_diagram.drawio");

Примеры использования

Генерация диаграмм во всех форматах

using UmlKit;
using Microsoft.EntityFrameworkCore;

using var context = new MyDbContext();

// PlantUML
string puml = UmlGenerator.ToPlantUml(context);
File.WriteAllText("diagram.puml", puml);

// Mermaid
string mermaid = UmlGenerator.ToMermaid(context);
File.WriteAllText("diagram.mermaid", mermaid);

// Текстовый формат
string text = UmlGenerator.ToText(context);
File.WriteAllText("diagram.txt", text);

// Draw.io
UmlGenerator.SaveDrawIo(context, "diagram.drawio");

Вывод текстовой диаграммы в консоль

using var context = new MyDbContext();
Console.WriteLine(UmlGenerator.ToText(context));

// Пример вывода:
// --- Employee ---
//   Id : int [PK]
//   Name : string
//   DepartmentId : int [FK]
//
// --- Department ---
//   Id : int [PK]
//   Name : string