Diagrammi di sequenza in Confluence
Un diagramma di sequenza mostra i messaggi che persone e sistemi si scambiano, nell’ordine in cui avvengono.
Ultimo aggiornamento
Quando usarlo
Usa un diagramma di sequenza per spiegare un’interazione nel tempo: una chiamata API, un login con un identity provider, un checkout su tre servizi. Ogni partecipante ha una linea verticale e ogni messaggio è una freccia tra due linee, da leggere dall’alto verso il basso. È il diagramma tipico delle specifiche API e delle analisi degli incidenti.
Esempio
Questo è il codice del modello API request: una chiamata del client, autenticata e servita dal database.
sequenceDiagram
autonumber
participant Client
participant API
participant Auth as Auth service
participant DB as Database
Client->>API: GET /orders
API->>Auth: Validate token
Auth-->>API: Token valid
API->>DB: SELECT orders
DB-->>API: Rows
API-->>Client: 200 OK (orders)
Vellnar Diagrams lo disegna così:
Cambia una riga e il diagramma cambia con lei. A nessuno serve il file originale del disegno, perché non esiste: il codice è il diagramma.
Aggiungerlo a una pagina di Confluence
- Modifica una pagina di Confluence e scrivi
/mermaiddove vuoi il diagramma. - Seleziona Mermaid diagram. Si apre l’editor con l’elenco dei modelli.
- Scegli un modello, oppure Start blank e incolla il codice qui sopra. L’anteprima segue ogni tasto.
- Scegli Save. Il diagramma compare nella pagina.
La documentazione spiega l’editor, le impostazioni e le esportazioni.
Modelli
Il pulsante Templates dell’editor ha 6 modelli pronti per questo tipo:
- API request: Una chiamata del client, autenticata e servita dal database.
- Login with an identity provider: Reindirizzamento, credenziali, token e il percorso di errore.
- Checkout: Ordine, pagamento e prenotazione della merce su tre sistemi.
- Support ticket: Un ticket che gira tra cliente, operatore e sviluppo.
- Order saga: I passi di pagamento, magazzino e spedizione, annullati al contrario quando la spedizione fallisce.
- Cache-aside: Lettura dalla cache, ripiego sul database e riempimento della cache.
Sintassi
Il codice inizia con sequenceDiagram. La documentazione di Mermaid (in inglese) descrive ogni elemento della sintassi. Vellnar Diagrams lo disegna con Mermaid 12.3; se una riga ha un errore, l’editor segna la riga e tiene a schermo l’ultimo diagramma valido.
Altro
- Mermaid in Confluence: come funzionano i diagrammi scritti come codice in una pagina, e tutti i tipi di diagramma.
- Sicurezza: l’app non chiede nessun permesso e non manda nulla fuori da Atlassian.