UmlKit 8.6.0

UmlKit

Генерация UML/ER-диаграмм из EF Core DbContext за одну строку кода (.NET 8).

Установка

dotnet add package UmlKit

Возможности

• Диаграммы классов в формате PlantUML
• ER-диаграммы в формате Mermaid (отображаются на GitHub, GitLab)
• Простая текстовая ER-диаграмма
• Экспорт в Draw.io (XML-формат)
• Автоматическое определение первичных и внешних ключей
• Отображение связей между сущностями

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

PlantUML

using UmlKit;

string plantuml = UmlGenerator.ToPlantUml(db);
File.WriteAllText("diagram.puml", plantuml);

Mermaid (для GitHub)

string mermaid = UmlGenerator.ToMermaid(db);
File.WriteAllText("diagram.md", "```mermaid\n" + mermaid + "\n```");

Текстовый формат

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

Draw.io

// Получить XML-строку
string xml = UmlGenerator.ToDrawIo(db);

// Или сохранить сразу в файл
UmlGenerator.SaveDrawIo(db, "diagram.drawio");

Пример: пункт 1 билета -- диаграммы UML из кода за 1 строку

public partial class MainForm : Form
{
    private void btnExportUml_Click(object sender, EventArgs e)
    {
        using var db = new AppDbContext();

        // PlantUML — для подробных диаграмм классов
        string puml = UmlGenerator.ToPlantUml(db);
        File.WriteAllText("diagram.puml", puml);

        // Mermaid — для отображения на GitHub
        string mermaid = UmlGenerator.ToMermaid(db);
        File.WriteAllText("er-diagram.md", "```mermaid\n" + mermaid + "\n```");

        // Draw.io — для редактирования в визуальном редакторе
        UmlGenerator.SaveDrawIo(db, "diagram.drawio");

        // Текстовый — для вывода в консоль или TextBox
        string text = UmlGenerator.ToText(db);
        textBoxDiagram.Text = text;

        MessageBox.Show("Диаграммы сохранены!");
    }
}

Пример вывода (PlantUML)

@startuml

class Vacancy {
  +int Id <<PK>>
  +string Title
  +decimal Salary
  +int DepartmentId <<FK>>
}

class Department {
  +int Id <<PK>>
  +string Name
}

Department "1" --> "*" Vacancy

@enduml

Пример вывода (Mermaid)

erDiagram
  Vacancy {
    int Id PK
    string Title
    decimal Salary
    int DepartmentId FK
  }
  Department {
    int Id PK
    string Name
  }

  Department ||--o{ Vacancy : has

Описание методов

Требования

• .NET 8.0
• Entity Framework Core

Лицензия

MIT