Quick Start

İlk doğrulanmış mimari diyagramınızı altı adımda oluşturun. Her adımda yeni bir Datro konsepti tanıtılıyor. Sonunda, SVG olarak dışa aktarmaya hazır, eksiksiz, stillendirilmiş, kısıtlamaları kontrol edilmiş bir diyagrama sahip olacaksınız.

Her .dtro dosyası sihirli bir başlıkla başlar. Bundan sonra düğümleri (varlıklar) ve kenarları (ilişkiler) bildirin. Bunu düzenleyiciye yapıştırın:

#!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 bloğu rastgele anahtar-değer meta verilerini tutar. Değerler dizeler, sayılar, boolean'lar veya diziler olabilir. Ortak özellikler şunlardır: tech, owner, deprecated ve sla.

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

Öznitelikler JSON IR'ye geçer ve oluşturulan SVG'de araç ipuçları olarak görünür; çağrı sırasında ve SLA meta verileri için kullanışlıdır.

Kenarlarda bir tür (anlamsal ilişki türü), isteğe bağlı bir etiket, bir ağırlık (göreceli trafik) ve bir async bayrağı bulunur. Eşzamansız kenarlar kesikli çizgiler olarak işlenir.

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

İlgili düğümleri kümelemek için bir grup bloğu kullanın. Gruplar SVG'de etiketli alt grafik kutuları olarak oluşturulur. Bir düğüm yalnızca bir gruba ait olabilir.

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

Kısıtlamalar makine tarafından kontrol edilen mimari kurallardır. Doğrulayıcı bunları IR'ye göre değerlendirir ve bir kural ihlal edildiğinde E501 hataları döndürür.

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

database !-> external kuralı şu anlama gelir: database tipindeki hiçbir düğüm, external tipindeki herhangi bir düğüme yönlendirilmiş bir kenara sahip olamaz. Bu, yanlışlıkla doğrudan DB → üçüncü taraf API çağrılarını engeller.

Bir layout bloğuyla diyagramın nasıl düzenleneceğini kontrol edin ve bir theme bloğuyla bir renk paleti tanımlayın. Herhangi bir renk WCAG AA kontrastının altına düşerse erişilebilirlik kontrolü W602 tetiklenir.

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

• Her blok türünün tam söz dizimi için Language Reference'ı okuyun.
• Komut satırından doğrulamak, biçimlendirmek ve dışa aktarmak için CLI Reference'ı kullanın.
• Açıklama veya işaretleme eklentisi ile dokümanların nasıl embed diagrams in Markdown yapılacağını öğrenin.