Quick Start

Erstellen Sie in sechs Schritten Ihr erstes validiertes Architekturdiagramm. Jeder Schritt führt ein neues Datro-Konzept ein. Am Ende verfügen Sie über ein vollständiges, gestaltetes und auf Einschränkungen überprüftes Diagramm, das Sie als SVG exportieren können.

Jede .dtro-Datei beginnt mit einem magischen Header. Danach deklarieren Sie Knoten (Entitäten) und Kanten (Beziehungen). Fügen Sie dies in den Editor ein:

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

Der Block attrs enthält beliebige Schlüsselwert-Metadaten. Werte können Zeichenfolgen, Zahlen, boolesche Werte oder Arrays sein. Gemeinsame Attribute sind tech, owner, deprecated und sla.

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

Attribute werden an die JSON IR weitergeleitet und als Tooltips im gerenderten SVG angezeigt – nützlich für Bereitschafts- und SLA-Metadaten.

Kanten haben eine Art (semantischer Beziehungstyp), ein optionales Label, ein Gewicht (relativer Datenverkehr) und ein asynchrones Flag. Asynchrone Kanten werden als gestrichelte Linien dargestellt.

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

Verwenden Sie einen Gruppen-Block, um verwandte Knoten zu gruppieren. Gruppen werden im SVG als beschriftete Unterdiagrammfelder dargestellt. Ein Knoten kann nur einer Gruppe angehören.

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

Einschränkungen sind maschinell überprüfte Architekturregeln. Der Validator wertet sie anhand der IR aus und gibt E501-Fehler zurück, wenn eine Regel verletzt wird.

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

Die Regel database !-> external bedeutet: Kein Knoten vom Typ database darf eine gerichtete Kante zu irgendeinem Knoten vom Typ external haben. Dies blockiert versehentliche direkte DB → API-Aufrufe von Drittanbietern.

Steuern Sie die Anordnung des Diagramms mit einem layout-Block und definieren Sie eine Farbpalette mit einem theme-Block. Die Barrierefreiheitsprüfung löst W602 aus, wenn eine Farbe unter den WCAG AA-Kontrast fällt.

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

• Lesen Sie Language Reference für die vollständige Syntax jedes Blocktyps.
• Verwenden Sie CLI Reference zum Validieren, Formatieren und Exportieren über die Befehlszeile.
• Erfahren Sie, wie Sie Dokumente mit dem Remark- oder Markdown-it-Plugin embed diagrams in Markdown erstellen.