Quick Start

Du skal bygge dit første validerede arkitektoniske diagram i seks trin. Hvert trin introducerer et nyt Datro-koncept. I slutningen vil du have et komplet, stiliseret, begrænsningskontrolleret diagram klar til eksport som SVG.

Hver .dtro-fil begynder med en magisk overskrift. Efter det angives nodes (entiteter) og edges (forbindelser). Læg dette ind i redaktøren:

#!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-blokken indeholder vilkårlige nøgleværdi metadata. Værdier kan være strenge, tal, boolean eller arrays. Vanlige attributter er tech, owner, deprecated og sla.

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

Attributter går gennem til JSON IR og vises som værktøjstips i den renderet SVG, der er nyttige for on-call og SLA metadata.

Ringer har en type (semantisk relation type), en valgfri etikette, en vægt (relativ trafik) og et async flag. Async kanter giver som streget linjer.

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

Brug en group blok til at klynge relaterede noder. Gruppen afleveres som mærkede undergraf bokser i SVG. En node kan kun tilhøre en gruppe.

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

Begrænsninger er maskinkontrollerede arkitektoniske regler. Validereren evaluerer dem mod IR og returnerer E501 fejl, når en regel overtrædes.

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

Reglen database !-> external betyder, at ingen node af typen database må have en rettet kant til en node af typen external. Dermed blokeres utilsigtede direkte kald fra databasen til tredjeparts-API’er.

Kontroller, hvordan diagrammet er arrangeret med et layout-blok og definere en farvepalette med et theme-blok. Tilgængelighedskontrolen aktiverer W602, hvis en farve falder under WCAG AA kontrast.

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

• Læs Talsreference for den fulde syntax af hver bloktype.
• Brug CLI Reference til at validerere, formatere og eksportere fra kommandoen.
• Lær at indlejre diagrammer i Markdown doc med bemærkningen eller markdown-it plugin.