Quick Start

W ciągu sześciu kroków wykonaj swój pierwszy zweryfikowany diagram architektoniczny. Każdy krok wprowadza nową koncepcję datro. W końcu masz kompletny, zaprojektowany i ograniczoną kontrolę wykresu, który możesz eksportować jako SVG.

Każdy .dtro-Plik zaczyna się od magicznego nagłówka. Następnie należy zadeklarować węzły i krawędzi.). Wpisz to do wydawcy:

#!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 }

Blok attrs zawiera dowolne metadata kluczowe. Wartości mogą być ciągami znaków, liczbami, wartościami boelicznymi lub arrayami. Wspólne atrybuty są: tech, owner, deprecated i sla.

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

Atrybuty są przekazywane do JSON IR i wyświetlane jako narzędzia w zgenerowanym SVG użyteczne dla metadanych gotowości i SLA.

Krawędzi mają rodzaj (typu semantycznej relacji), opcjonalny label, ciężar** (relacyjnego ruchu danych) i asynchroniczny flag. Asynchronizowane krawędzi są przedstawiane jako linie rozmieszczone.

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

Użyj bloku group, aby zgrupować spokrewnione węzły. Grupy są przedstawiane w SVG jako oznakowane pola poddiagramowe. Węzeł może należeć do jednej grupy.

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" }

Ograniczenia to mechanicznie sprawdzone zasady architektury. Validator ocenia je w oparciu o IR i E501-Zwracanie błędów, gdy narusza się regułę.

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

Zasada database!-> external Nie ma żadnych węzłów typu database może mieć obręb skierowany do jednego z węzłów typu external Właściciele. Zablokuje to przypadkowe bezpośrednie DB → API połączenia zewnętrznych dostawców.

Sterować układ wykresu za pomocą layout-Blok i zdefiniować paletę kolorów theme-Blok. Sprawdzenie dostępności rozwiązuje W602 wygasnąć, gdy kolor spada pod kontrast 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 }
}

• Przeczytaj Language Reference dla pełnej syntaxy każdego typu bloku.
• Wykorzystaj CLI Reference do weryfikacji, formatowania i eksportowania za pomocą linii poleceń.
• Dowiedz się, jak tworzyć dokumenty za pomocą wtyczki Remark lub Markdown-it.