Miten kirjoitat mermaid-sekvenssikaavion

Vähimmäismäärä

Määrittele kaaviotyyppi ja kirjoita sitten yksi rivi per viesti. Osallistujat luodaan ensimmäisellä maininnalla, siinä järjestyksessä kuin he esiintyvät.

sequenceDiagram
  User->>API: POST /orders
  API->>DB: INSERT order
  DB-->>API: order id
  API-->>User: 201 Created

💡Määrittele osallistujat eksplisiittisesti participant User-rivillä, kun haluat tietyn vasemmalta-oikealle-järjestyksen sen sijaan että käytettäisiin ensimmäisen maininnan järjestystä.

Nuolityypit

Tämä käytäntö kannattaa säilyttää: yhtenäinen viiva kutsulle, katkoviiva paluulle. Lukija näkee tällöin pyynnön vastauksesta lukematta yhtäkään selitettä.

Osallistujat ja aliakset

sequenceDiagram
  participant U as Browser
  participant A as API gateway
  participant S as Order service
  U->>A: GET /orders
  A->>S: list(userId)
  S-->>A: orders
  A-->>U: 200 OK

Käytä actor U as Browser-merkintää participant-merkinnän sijaan piirtääksesi tikku-ukon — kannattaa autentikointivuon vasemmassa reunassa olevalle ihmiselle.

Aktivointipalkit

Aktivointipalkit näyttävät miten kauan osallistuja on varattu. Merkitse ne joko eksplisiittisesti activate/deactivate-komennoilla, tai lisää nuoliin + ja - — se on lyhyempi ja vaikeampi saada epätasapainoon.

sequenceDiagram
  User->>+API: POST /pay
  API->>+Bank: charge
  Bank-->>-API: authorised
  API-->>-User: receipt

Silmukat, ehdot ja rinnakkainen työ

sequenceDiagram
  User->>API: POST /import
  loop every row
    API->>DB: upsert row
  end
  alt all rows valid
    API-->>User: 200 OK
  else some failed
    API-->>User: 422 with errors
  end
  par notify
    API->>Email: send summary
  and audit
    API->>Log: write entry
  end

• loop <label> … end — toisto.
• alt <label> … else <label> … end — toisensa poissulkevat haarat.
• opt <label> … end — haara joka ei ehkä yksinkertaisesti tapahdu.
• par <label> … and <label> … end — asioita jotka tapahtuvat samaan aikaan.
• critical / break — osio jota ei saa keskeyttää, ja varhainen poistuminen.

Huomautukset

sequenceDiagram
  User->>API: POST /login
  Note right of API: Rate limited<br>5 per minute
  API-->>User: token
  Note over User,API: Token is valid for 30 days

Note over A,B kattaa kaksi osallistujaa ja on oikea paikka rajoitukselle joka kuuluu itse vuorovaikutukselle eikä kummallekaan osapuolelle erikseen.

Täysi esimerkki

sequenceDiagram
  actor U as User
  participant A as App
  participant P as Provider
  U->>+A: Click "Sign in"
  A-->>-U: Redirect to provider
  U->>+P: Authorise
  P-->>-U: Redirect back with code
  U->>+A: GET /callback?code=…
  A->>+P: Exchange code for token
  P-->>-A: access token
  Note right of A: Session cookie set here
  A-->>-U: Signed in