Quick Start

Laita kuusi askelta ensimmäinen arkkitehtuurin validoitu kaavio. Jokainen askel tuottaa uuden Datro-konseptin. Lopuksi sinulla on täydellinen, suunniteltu ja rajoituksellisesti tarkistettu kaavio, jonka voit viedä SVG:ksi.

Jokainen .dtro-Tiedosto alkaa maagisella otsikolla. Seuraavaksi ilmoitetaan *nimikkeet* (yksiköitä) ja *marginaalit* (suhteita). Lisää tämä toimittajaan:

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

Rakennus attrs sisältää mitä tahansa avain-arvo-metadata. Arvot voivat olla merkkejä, numeroita, boolisia arvoja tai sarjoja. Yhteiset ominaisuudet ovat tech, owner, deprecated ja sla.

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

Attribuutit siirretään JSON IR:hen ja näytetään muutettuna SVG:ssä työkaluina.

Kanteilla on type (semantinen suhde tyyppi), optionaalinen label, weight (suhteellinen tietoverko) ja asynkroninen lippu. Asynkroniset reunat on esitettävä riittäminä linjoina.

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

Käytä group-lokkaa yhdistämään sukupuolisia solmuja. ryhmät esitetään SVG:ssä merkittyjen aladiagrammin kenttien. Kytkö voi kuulua vain yhteen ryhmään.

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

Rajoitukset ovat koneellisesti tarkistettuja arkkitehtuurisia sääntöjä. Validaattori arvioi ne IR:n perusteella ja antaa E501-Virheitä palautetaan sääntöjen rikkomisesta.

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

Sääntö database!-> external Se tarkoittaa, että ei ole tyypin kytkiä. database voi olla suunnattu ääri johonkin tyyppiseen kytkeen external ovat. Tämä estää epäonnistuneita kolmansien osapuolten suoria DB → API-pyyntöjä.

Ohjaa kaavan järjestys layout-Pysäytä ja määrittele väripalletti theme-Blokki. Käyttöoikeuden tarkastus ratkaisee W602 Jos väri putoaa WCAG AA-kontrastiin.

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

• Luki Language Reference jokaisen blokityypin täydellisen syntaksin.
• Käytä CLI Reference validoimaan, muokkaamaan ja vientiä käskyjen kautta.
• Lue, miten luoda asiakirjoja Remark- tai Markdown-it-pluginilla embed diagrams in Markdown.