Quick Start

Կառուցեք ձեր առաջին վավերացված ճարտարապետական դիագրամը վեց քայլով: Յուրաքանչյուր քայլ ներկայացնում է մեկ նոր Datro հայեցակարգ: Վերջում դուք կունենաք ամբողջական, ոճավորված, սահմանափակումներով ստուգված դիագրամ, որը պատրաստ կլինի արտահանել որպես SVG:

Յուրաքանչյուր .dtro ֆայլ սկսվում է կախարդական վերնագրով: Դրանից հետո հայտարարեք հանգույցներ (սուբյեկտներ) և եզրեր (հարաբերություններ): Տեղադրեք սա խմբագրի մեջ.

#!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 բլոկը պահում է կամայական բանալի-արժեքի մետատվյալներ: Արժեքները կարող են լինել տողեր, թվեր, բուլյաններ կամ զանգվածներ: Ընդհանուր ատրիբուտներն են tech, owner, deprecated և sla։

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

Հատկանիշները անցնում են JSON IR-ին և հայտնվում են որպես գործիքի հուշումներ ներկայացված SVG-ում, որոնք օգտակար են զանգի և SLA մետատվյալների համար:

Եզրերն ունեն kind (իմաստային հարաբերությունների տեսակ), կամընտիր պիտակ, քաշ (հարաբերական տրաֆիկ) և async դրոշ: Անհամաժամեցված եզրերը ներկայացվում են որպես գծավոր գծեր:

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

Օգտագործեք խմբ բլոկ՝ կապված հանգույցների կլաստերավորման համար: Խմբերը ներկայացվում են որպես պիտակավորված ենթագրաֆիկ տուփեր SVG-ում: Հանգույցը կարող է պատկանել միայն մեկ խմբի:

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

Սահմանափակումները մեքենայով ստուգված ճարտարապետական ​​կանոններ են: Վալիդատորը գնահատում է դրանք IR-ի համեմատ և վերադարձնում E501 սխալները, երբ կանոնը խախտվում է:

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

database !-> external կանոնը նշանակում է՝ database տիպի ոչ մի հանգույց չի կարող ուղղորդված եզր ունենալ դեպի external տիպի ցանկացած հանգույց։ Սա արգելափակում է պատահական ուղղակի DB → երրորդ կողմի API զանգերը:

Վերահսկեք, թե ինչպես է դիագրամը դասավորվում layout բլոկով և սահմանեք գունային գունապնակ theme բլոկով: Մատչելիության ստուգումը գործարկում է W602, եթե որևէ գույն ընկնում է 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 }
}

• Կարդացեք Language Reference բլոկի բոլոր տեսակի ամբողջական շարահյուսությունը:
• Օգտագործեք CLI Reference՝ հրամանի տողից վավերացնելու, ձևաչափելու և արտահանելու համար:
• Իմացեք, թե ինչպես պետք է embed diagrams in Markdown փաստաթղթավորել դիտողությունների կամ նշագրման հավելվածի միջոցով: