Mermaid Sıra Diyagramı Sözdizimi
Sıra diyagramları, bileşenlerin zaman içinde nasıl etkileşime girdiğini gösterir. Her dikey çizgi bir katılımcıdır (hizmet, kullanıcı, sistem) ve yatay oklar aralarında geçen mesajlardır. API akışlarını, kimlik doğrulama el sıkışmalarını ve dağıtık sistem etkileşimlerini belgelemek için standart yöntemdir.
Katılımcılar
Sıralarını soldan sağa kontrol etmek için katılımcıları bildirin:
sequenceDiagram
participant Tarayıcı
participant API
participant Veritabanı
Açık participant bildirimleri olmadan, Mermaid onları ilk göründükleri sırayla oluşturur. İnsan kullanıcılar için participant yerine actor kullanın.
Mesaj Türleri
| Sözdizi | Anlamı |
|---|---|
A->>B: metin | Senkron çağrı (düz çizgi, dolu ok) |
A-->>B: metin | Async/dönüş (kesikli çizgi, dolu ok) |
A-xB: metin | Kayıp mesaj (düz, çarpı) |
A--xB: metin | Kayıp async (kesikli, çarpı) |
Aktivasyon Çubukları
Bir katılımcının aktif olarak işlem yaptığını gösterin:
sequenceDiagram
İstemci->>+API: İstek
API->>+DB: Sorgu
DB-->>-API: Sonuç
API-->>-İstemci: Yanıt
->> sonrası + hedefi etkinleştirir. - devre dışı bırakır.
Kontrol Akışı
Koşullar
alt Başarılı
API-->>İstemci: 200 OK
else Bulunamadı
API-->>İstemci: 404
end
Döngüler
loop Her 30 saniyede
İstemci->>API: Sinyal
API-->>İstemci: ACK
end
İsteğe bağlı
opt Önbellek varsa
API->>Önbellek: Sonucu al
Önbellek-->>API: Önbelleklenmiş veri
end
Notlar
Note left of API: JWT doğrular
Note right of DB: Okuma yedeği
Note over İstemci,API: Yalnızca HTTPS
Numaralandırma
sequenceDiagram sonrası autonumber ekleyin, her mesajı otomatik numaralandırmak için.
Pratik Desenler
REST API kimlik doğrulama
Bu örneğin başlangıç durumu, ardından kimliği doğrulanmış bir isteğin izlediği eksiksiz bir giriş akışı gösterir. Bu desen neredeyse her web uygulamasında görülür.
Veri modeli belgelemesi için Mermaid ER Diyagramı tablo ilişkilerini gösterir. Zaman sıralaması olmayan süreç akışları için Mermaid Akış Şeması kullanın.