چطور یک نمودار توالی mermaid بنویسیم

حداقل لازم

نوع نمودار را اعلام کنید، سپس یک خط برای هر پیام بنویسید. participant ها در اولین اشاره‌ای که به آن‌ها می‌شود، به همان ترتیب، ساخته می‌شوند.

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

💡وقتی ترتیب مشخصی از چپ به راست می‌خواهید، به‌جای ترتیب اولین اشاره، participant ها را با participant User صریحاً اعلام کنید.

انواع پیکان

قراردادی که ارزش نگه‌داشتن دارد: توپر برای فراخوانی، نقطه‌چین برای بازگشت. این‌طوری خواننده می‌تواند بدون خواندن حتی یک برچسب، درخواست را از پاسخ تشخیص دهد.

participant ها و نام‌های مستعار

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

به‌جای participant، از 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 روی دو participant پخش می‌شود و جای درستی برای محدودیتی است که به تعامل تعلق دارد نه به یکی از دو طرف آن.

یک مثال کامل

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