Як написати sequence-діаграму mermaid

Мінімум

Оголосіть тип діаграми, а потім пишіть по одному рядку на кожне повідомлення. Учасники створюються при першій згадці, у порядку появи.

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, щоб намалювати фігурку людини — варто для людини на лівому краю потоку автентифікації.

Смуги активації

Смуги активації показують, скільки часу учасник зайнятий. Позначайте їх явно через 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