Quick Start

Skapa ditt första validerade arkitektoniska diagram i sex steg. Varje steg introducerar en ny datorkoncept. Slutligen har du en fullständig, utformad och begränsningsvis kontrollerad diagram som du kan exportera som SVG.

Varje fil börjar med en magisk header. Därefter ska du ange *knot* (enheter) och *kant* (förhållanden). Lägg in detta 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 }

Blocket attrs innehåller eventuella nyckelvärde metadata. Värden kan vara tecknade rader, siffror, bokvärden eller arrayer. Gemensamma attribut är tech, owner, deprecated och sla.

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

Attribut vidarebefordras till JSON IR och visas som verktygstyper i den härdade SVG Användbar för redo- och SLA-metadata.

Kanten har en typ (semantisk relationstype), en optionala etikett, en vikt (relativ dataflöde) och en asynchrons flagg. Asynkrona kantar framställs som linjer.

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

Använd en group-block för att gruppera relaterade knoppar. Grupper visas i SVG som markerade underdiagramfält. En knopp kan endast vara en grupp.

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änsningar är maskinverifierade arkitektoniska regler. Valideraren bedömer det utifrån IR och returnerar E501-fel om en regel bryts.

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

Regeln database!-> external innebär att inga knop av typen database får ha en riktad kant mot någon knop av typen external. Detta blockerar oavsiktliga direkt DB → API-användningar från tredje part.

Kontrollera anordningen av diagrammet med ett layout-block och definiera en färgpalet med ett theme-block. Tillgänglighetsprovet ger upphov till W602 när en färg faller under WCAG AA-kontrasten.

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 Language Reference för den fullständiga syntaxen för varje blocktyp.
• Använd CLI Reference för att validera, formatera och exportera via kommandoträckarna.
• Lär dig hur man skapar dokument med Remark- eller Markdown-it-plugin [embed diagram i Markdown].