Quick Start

Создайте свою первую проверенную архитектурную схему за шесть шагов. Каждый шаг представляет одну новую концепцию Datro. К концу у вас будет полная, оформленная и проверенная по ограничениям диаграмма, готовая к экспорту в формате SVG.

Каждый файл .dtro начинается с магического заголовка. После этого объявите узлы (сущности) и ребра (отношения). Вставьте это в редактор:

#!DATRO 1.0

node frontend { type: web      label: "React App" }
node backend  { type: service  label: "NestJS API" }
node db       { type: database label: "PostgreSQL" }

edge frontend -> backend { kind: http }
edge backend  -> db      { kind: query }

Блок attrs содержит произвольные метаданные «ключ-значение». Значения могут быть строками, числами, логическими значениями или массивами. Общие атрибуты: tech, owner, deprecated и sla.

node backend {
  type:  service
  label: "NestJS API"
  attrs {
    tech:  "nestjs"
    owner: "platform-team"
  }
}

Атрибуты передаются в JSON IR и отображаются в виде всплывающих подсказок в визуализированном SVG, что полезно для метаданных дежурства и SLA.

Края имеют вид (тип семантической связи), необязательную метку, вес (относительный трафик) и флаг async. Асинхронные края отображаются в виде пунктирных линий.

edge backend -> stripe {
  kind:  http
  label: "charge API"
  async: false
}

Используйте блок group для кластеризации связанных узлов. Группы отображаются как помеченные поля подграфов в SVG. Узел может принадлежать только одной группе.

group data_tier {
  label:   "Data Layer"
  members: [db, redis_cache]
}

node redis_cache { type: cache label: "Redis" }

edge backend -> redis_cache { kind: read  label: "session" }

Ограничения — это архитектурные правила, проверяемые машиной. Валидатор сравнивает их с IR и возвращает ошибки E501 при нарушении правила.

constraint {
  id:       "no-db-external"
  rule:     "database !-> external"
  message:  "Databases must not connect to external services"
  severity: error
}

Правило database !-> external означает: ни один узел типа database не может иметь направленного ребра к любому узлу типа external. Это блокирует случайные прямые вызовы БД → сторонние API.

Управляйте расположением диаграммы с помощью блока layout и определяйте цветовую палитру с помощью блока theme. Проверка доступности срабатывает W602 если какой-либо цвет падает ниже контрастности WCAG AA.

layout { direction: LR  algo: dagre  node_sep: 60  rank_sep: 120 }

theme {
  palette {
    service:    "#D0E8FF"
    database:   "#FFE8C0"
    web:        "#E8D0FF"
    cache:      "#C0FFE8"
    background: "#FFFFFF"
  }
  accessibility { min_contrast: AA }
}

• Прочтите Language Reference для получения полного синтаксиса каждого типа блока.
• Используйте CLI Reference для проверки, форматирования и экспорта из командной строки.
• Узнайте, как редактировать документы embed diagrams in Markdown с помощью плагина примечаний или уценки.