Quick Start

Construisez votre premier diagramme d'architecture validé en six étapes. Chaque étape introduit un nouveau concept Datro. À la fin, vous aurez un diagramme complet, stylisé et vérifié par les contraintes, prêt à être exporté au format SVG.

Chaque fichier .dtro commence par un en-tête magique. Après cela, déclarez les nœuds (entités) et les bords (relations). Collez ceci dans l'éditeur :

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

Le bloc attrs contient des métadonnées clé-valeur arbitraires. Les valeurs peuvent être des chaînes, des nombres, des booléens ou des tableaux. Les attributs communs sont tech, owner, deprecated et sla.

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

Les attributs sont transmis au JSON IR et apparaissent sous forme d'info-bulles dans le SVG rendu, ce qui est utile pour les métadonnées d'astreinte et SLA.

Les bords ont un kind (type de relation sémantique), un label facultatif, un weight (trafic relatif) et un indicateur async. Les bords asynchrones s'affichent sous forme de lignes pointillées.

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

Utilisez un bloc group pour regrouper les nœuds associés. Les groupes s'affichent sous forme de zones de sous-graphiques étiquetées dans le SVG. Un nœud ne peut appartenir qu’à un seul groupe.

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

Les contraintes sont des règles architecturales vérifiées automatiquement. Le validateur les évalue par rapport à l'IR et renvoie des erreurs E501 lorsqu'une règle est violée.

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

La règle database !-> external signifie : aucun nœud de type database ne peut avoir un bord dirigé vers un nœud de type external. Cela bloque les appels directs accidentels à la base de données → à l'API tierce.

Contrôlez la façon dont le diagramme est organisé avec un bloc layout et définissez une palette de couleurs avec un bloc theme. Le contrôle d'accessibilité déclenche W602 si une couleur tombe en dessous du contraste 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 }
}

• Lisez le Language Reference pour la syntaxe complète de chaque type de bloc.
• Utilisez le CLI Reference pour valider, formater et exporter à partir de la ligne de commande.
• Apprenez à créer des documents embed diagrams in Markdown avec le plugin remarque ou markdown-it.