Jak napsat mermaid sekvenční diagram

Minimum, které stačí

Deklarujte typ diagramu a pak pište jeden řádek na zprávu. Účastníci vznikají při první zmínce, v pořadí, v jakém se objeví.

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

💡Účastníky deklarujte explicitně pomocí participant User, chcete-li konkrétní pořadí zleva doprava místo pořadí první zmínky.

Typy šipek

Konvence, kterou se vyplatí dodržovat: plná čára pro volání, čárkovaná pro návrat. Čtenář pak pozná požadavek od odpovědi, aniž by přečetl jediný popisek.

Účastníci a aliasy

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

Místo participant použijte actor U as Browser, chcete-li nakreslit panáčka — hodí se to pro člověka na levém okraji přihlašovacího flow.

Aktivační pruhy

Aktivační pruhy ukazují, jak dlouho je účastník zaneprázdněný. Buď je označte explicitně pomocí activate/deactivate, nebo přidejte + a - k šipkám, což je kratší a hůř se to rozejde.

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

Smyčky, podmínky a paralelní práce

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 — opakování.
• alt <label> … else <label> … end — vzájemně vylučující se větve.
• opt <label> … end — větev, ke které nemusí vůbec dojít.
• par <label> … and <label> … end — věci probíhající současně.
• critical / break — sekce, kterou nelze přerušit, a předčasný výstup.

Poznámky

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 se rozpíná přes dva účastníky a je správné místo pro omezení, které patří k interakci jako celku, ne jen k jedné straně.

Kompletní příklad

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