Как да напишеш mermaid sequence диаграма

Минимумът

Декларирай вида на диаграмата, после напиши по един ред на съобщение. Участниците се създават при първото им споменаване, в реда, в който се появяват.

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

💡Декларирай участниците изрично с participant User, когато искаш конкретен ред отляво надясно, вместо реда на първото им споменаване.

Видове стрелки

Конвенцията, която си струва да пазиш: плътна линия за извикването, пунктирана за връщането. Тогава читателят може да разпознае заявка от отговор, без да чете нито един етикет.

Участници и псевдоними

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

Използвай actor U as Browser вместо participant, за да нарисуваш човече — струва си за човека в левия край на flow за автентикация.

Ленти за активност

Лентите за активност показват колко дълго участникът е зает. Маркирай ги изрично с activate/deactivate, или добави + и - към стрелките, което е по-кратко и по-трудно да се разбалансира.

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

Цикли, условия и паралелна работа

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 — повторение.
• alt <label> … else <label> … end — взаимно изключващи се разклонения.
• opt <label> … end — разклонение, което може просто да не се случи.
• par <label> … and <label> … end — неща, случващи се едновременно.
• critical / break — секция, която не бива да бъде прекъсвана, и ранен изход.

Бележки

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 обхваща двама участници и е правилното място за ограничение, което принадлежи на взаимодействието, а не на едната или другата страна.

Пълен пример

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