Vai alla documentazione

SEGUI LA CONVERSAZIONE

Diagramma di sequenza: guida

Crea interazioni ordinate di API e servizi con partecipanti, chiamate, risposte, diramazioni e note.

Partecipanti e messaggi → Diagramma di sequenzaApri diagramma di sequenza

Segui la conversazione

Diagramma di sequenza è uno spazio di lavoro visivo indipendente per le interazioni tra persone, servizi e sistemi. I partecipanti vanno da sinistra a destra; il tempo scorre verso il basso nella pagina. La struttura del flusso e il diagramma mostrano lo stesso modello ordinato.

Scegli il modello di richiesta API per esplorare un client, l'API degli ordini, il servizio di autenticazione e il database. Il modello verifica un token e utilizza un gruppo if/else per restituire gli ordini o una risposta non autorizzata. Scegli Diagramma vuoto per creare la tua conversazione.

Crea un'interazione API

  1. Aggiungi i partecipanti per il Client e l'API. Selezionane uno nel pannello Flusso o sul diagramma per modificarne nome, simbolo, colore e ordine da sinistra a destra.
  2. La tela vuota ti guida attraverso i partecipanti e il tuo primo messaggio. I nuovi nomi e il testo del messaggio vengono selezionati in modo da poter digitare immediatamente. Scegli Messaggio, quindi modifica Da, A e Messaggio in Dettagli. La barra Aggiungi mostra dove andrà il nuovo passaggio e chi invia il messaggio. Viene aggiunto un messaggio dopo il passaggio selezionato, nello stesso ramo. La selezione di un partecipante avvia il messaggio successivo da quel partecipante; un messaggio selezionato fornisce i suoi endpoint. Le note aggiunte da un partecipante selezionato utilizzano quell'ancora. Senza alcun passaggio selezionato, viene aggiunto al flusso principale.
  3. Seleziona un messaggio e usa Aggiungi risposta dopo questo messaggio per invertire le sue estremità e aggiungere un ritorno tratteggiato. Trascina i passaggi per posizionarli nel tempo; l'anteprima mostra la loro destinazione. I controlli su/giù del flusso riordinano all'interno del ramo corrente.
  4. Usa Raggruppa → If / else, Opzionale, Loop o Parallelo. Seleziona un ramo per modificarne la condizione o aggiungere passaggi lì. Aggiungi ramo inserisce prima di un fallback else. In Flusso, ogni ramo ha il proprio pulsante +.
  5. Esegui i controlli, rivedi il diagramma e salva o esporta il risultato. Sui telefoni, usa le schede Flusso, Diagramma e Dettagli; Modifica dettagli apre l'elemento selezionato e Torna al diagramma ritorna al canvas.

Seleziona, sposta e aggiungi sul diagramma

Fai clic sull'intestazione di un partecipante o sulla linea di vita, sul messaggio, sulla nota, sul bordo del gruppo o sull'area di diramazione per selezionarli. Premi Invio o Spazio per aprire i Dettagli. Trascina le intestazioni dei partecipanti a sinistra o a destra per regolare la spaziatura e l'ordine; trascina messaggi, note o interi gruppi verticalmente per impostare il loro ordine temporale e lasciare uno spazio. Sui touchscreen, trascina la maniglia visibile; scorri altrove per scorrere.

L'anteprima mostra il diagramma proposto e indica il nome del ramo di destinazione. Rilascia in un altro ramo per trasferire un passaggio, oppure usa Sposta passaggio a nei Dettagli. Creazione e distruzione rimangono nel flusso principale; i gruppi non possono essere spostati al loro interno. Il trascinamento si adatta a griglie di 8 pixel. L'uso di Esc o l'annullamento lascia il modello invariato; il rilascio applica una modifica annullabile. Ridisponi ripristina la spaziatura automatica mantenendo l'ordine e i rami.

Fai clic sulla barra Aggiungi, oppure sul desktop trascina Partecipante, Messaggio, Nota o un Gruppo sul diagramma. Le scelte del gruppo spiegano Se / altrimenti, Facoltativo, Ciclo e Parallelo in linguaggio semplice. L'anteprima di rilascio e il piè di pagina dell'area di disegno assegnano un nome alla diramazione di destinazione e ne mostrano la posizione nel tempo. Il trascinamento dalla palette inizia con i primi due partecipanti; la direzione viene mostrata durante il trascinamento. Scegli gli endpoint dei messaggi nei Dettagli; rilasciare vicino a una linea di vita non li modifica.

Fai clic su un'area vuota dell'area di disegno per deselezionare. Trascina l'area di disegno vuota o usa il pulsante centrale del mouse per esplorare mantenendo la selezione. È possibile aggiungere un gruppo prima dei partecipanti; il suo segnaposto nell'area di disegno e il pulsante Flow + aggiungono il primo partecipante, quindi offrono il primo messaggio.

Partecipanti e linee di vita

Participant, Actor, Boundary, Control, Entity e Database cambiano il simbolo dell'intestazione. Sono ruoli in un'interazione, non tabelle di database. I nomi e i colori d'accento esadecimali opachi opzionali vengono salvati con il diagramma.

Trascina l'intestazione di un partecipante per posizionarla; le intestazioni vicine si spostano per rimanere leggibili. Sposta a sinistra e Sposta a destra ne invertono la posizione nell'ordine visualizzato. Gli endpoint dei messaggi rimangono invariati. Dettagli partecipante offre le azioni Invia messaggio e Aggiungi nota. Un messaggio allo stesso partecipante diventa automaticamente una chiamata a se stesso; un diagramma a un solo partecipante lo offre esplicitamente. Eliminare un partecipante rimuove anche i messaggi che lo coinvolgono e rimuove la sua ancora dalle note; Annulla ripristina la modifica completa.

Chiamate, risposte e cicli di vita

Chiamate, risposte e cicli di vita
TipoSignificato
Chiamata sincronaLinea continua e freccia piena. Il mittente attende l'operazione chiamata.
Messaggio asincronoLinea continua e freccia aperta. Il mittente può proseguire senza attendere.
Rispondi / restituisciLinea tratteggiata che torna al chiamante. Aggiungi risposta inverte gli endpoint del messaggio selezionato.
Crea partecipanteLa creazione appartiene alla prima interazione della linea di vita di destinazione. La sua intestazione inizia a questo messaggio.
Elimina partecipanteUna X segna la distruzione del target. Questa dovrebbe essere la sua ultima interazione.
Creazione e distruzione sono supportate nel flusso principale, al di fuori dei frammenti. I controlli segnalano un ordinamento temporale incoerente; un ordinamento non valido mantiene visibile l'intera linea di vita in modo che le interazioni successive non vengano nascoste.

Raggruppa i rami senza perdere il loro significato

If / else (alt) contiene 2–6 rami alternativi; viene scelto esattamente un operando corrispondente. Optional (opt) contiene un ramo condizionale. Loop contiene un ramo ripetuto; scrivi la condizione di iterazione. Parallel (par) contiene 2–6 operandi le cui interazioni possono interlacciarsi.

L'appartenenza a un ramo è esplicita. I pulsanti di flusso e Alt+Su/Giù mantengono un passaggio nel suo ramo corrente. Il trascinamento può trasferire un messaggio, una nota o un intero gruppo al ramo denominato nell'anteprima; "Sposta passaggio a" offre la stessa scelta nei Dettagli. Le destinazioni non valide sono disabilitate con una motivazione, inclusi lo spostamento di un gruppo all'interno di se stesso, il superamento di quattro livelli nidificati o l'inserimento di creazione/distruzione all'interno di un ramo.

La conversione di un gruppo multi-ramificazione in Opzionale o Ciclo richiede conferma prima di mantenere solo la prima ramificazione. L'eliminazione di una ramificazione richiede conferma prima di rimuovere i suoi passaggi; se rimane una sola ramificazione, il gruppo diventa Opzionale e l'eliminazione dell'unica ramificazione rimuove il gruppo. L'eliminazione di un gruppo rimuove tutti i suoi passaggi con richiesta di conferma. Annulla ripristina la modifica completa. La disposizione verticale dei rami paralleli non implica un ordine di esecuzione tra di essi.

Note, numerazione e attivazioni

Aggiungi una nota e seleziona i partecipanti che deve coprire. Le note vanno a capo all'interno del loro riquadro e si muovono con l'ordine della sequenza. Usale per vincoli o spiegazioni piuttosto che inserire un paragrafo su una freccia di messaggio.

La vista controlla i numeri di messaggio e le barre di attivazione automatica. Queste opzioni di aspetto vengono salvate e incluse nell'esportazione dell'immagine. I numeri forniscono un ordine di lettura; non sono timestamp misurati o un ordine di esecuzione totale tra rami paralleli.

Le barre di attivazione vengono dedotte dalle chiamate sincrone e dalle risposte disegnate. Le autociamate possono annidiarsi. I rami alternativi vengono calcolati separatamente in modo che le risposte in un ramo non chiudano le chiamate in un altro. Le risposte mancanti lasciano un'attivazione aperta fino alla fine di quel contesto; questo è un aiuto visivo piuttosto che un'analisi di esecuzione.

I nuovi diagrammi iniziano con una scala leggibile; i diagrammi ampi possono scorrere orizzontalmente. "Adatta alla larghezza del diagramma" offre una panoramica preservando la lettura verticale. Scorri per esplorare, usa i controlli di zoom o Ctrl/Command più lo scorrimento per ingrandire attorno al puntatore. La funzione "Trova" cerca nomi e tipi di partecipanti, messaggi e i loro endpoint, note, descrizioni di gruppi e condizioni. I passaggi corrispondenti mantengono il contesto del ramo pertinente; ID e posizioni sono esclusi. "Cancella" o "Esc" ripristinano l'intero flusso e un risultato vuoto spiega cosa provare. Selezionare un risultato di Flusso o di Controllo, o aggiungere un elemento, porta la sua etichetta in vista senza modificare lo zoom. Sui telefoni questo accade quando torni al Diagramma. Lo scorrimento, lo zoom e la selezione dell'area di lavoro sono viste dello spazio di lavoro esterne al documento e alla cronologia di Annulla.

Salva, condividi e importa

I nuovi diagrammi rimangono in memoria. Salva effettua l'accesso quando necessario e crea un file cloud di diagramma di sequenza indipendente. File → Apri diagrammi di sequenza apre il proprio elenco di file. Salva le ultime modifiche prima di condividere un link pubblico di sola lettura. I visualizzatori pubblici possono ispezionare ed esportare ma non possono modificare il file.

File → Scarica JSON mantiene il documento modificabile completo, incluse le posizioni dei partecipanti e gli spazi tra i passaggi. I salvataggi sul cloud e le esportazioni di immagini mantengono anch'essi questa disposizione. L'importazione JSON accetta file di diagramma di sequenza di Erd Go esportati versione 1 fino a 4 MB, convalida l'intero file prima della sostituzione e supporta Annulla. I file più vecchi mantengono la spaziatura automatica; le posizioni importate sovrapposte vengono visualizzate in modo sicuro. SQL, Diagramma delle classi, Mermaid e PlantUML non sono formati di importazione.

File → Nuovo diagramma apre nuovamente il selettore Vuoto/Modello. Vuoto e l'esempio di richiesta API sostituiscono un modello esistente con conferma e Annulla. I diagrammi non salvati chiedono conferma prima di uscire o ricaricare. Nulla viene scritto nella memoria del browser.

Esporta un diagramma o il codice sorgente

L'esportazione crea PNG, JPEG, WebP, SVG vettoriale autonomo o PDF basato su immagine. Scegli Intero diagramma o Vista corrente (apri prima il pannello Diagramma sui telefoni) e una larghezza HD, 2K o 4K. Le dimensioni raster sono limitate a 8192 pixel per lato e 16 megapixel; i diagrammi molto alti potrebbero essere ridotti. Usa SVG per diagrammi grandi e scalabili, o Vista corrente per una sezione leggibile.

File → Esporta anteprime PlantUML / Mermaid, copia e scarica testo locale. Il renderer di testo controlla il proprio layout e aspetto; i simboli o i colori dei partecipanti potrebbero differire. Il JSON è il formato modificabile completo. Nessun codice sorgente viene inviato a un server di rendering di terze parti.

Mermaid / Esempio di testo per il flusso di richieste API
sequenceDiagram
participant Client
participant API
participant Auth
participant Database
Client ->> API: GET /orders
API ->> Auth: verify token
Auth -->> API: identity
alt valid token
  API ->> Database: SELECT orders
  Database -->> API: orders[]
  API -->> Client: 200 OK
else invalid token
  API -->> Client: 401 Unauthorized
end
Crea questo flusso visivamente o usa il modello di richiesta API. L'esempio illustra l'esportazione di testo; non può essere importato in Erd Go.

Scorciatoie e limiti

Scorciatoie e limiti
Azione o limiteComportamento
Ctrl/Cmd+SSalva nel cloud; effettua l'accesso quando richiesto.
Ctrl/Cmd+KApri e seleziona Trova nel pannello Flusso.
Ctrl/Cmd+Z / Shift+Z / Ctrl+YAnnulla / Ripristina all'esterno dei campi di testo. I campi di testo mantengono le scorciatoie di modifica native.
Invio / SpaziatriceApri i Dettagli per l'elemento del diagramma selezionato.
Alt+Sinistra / DestraSposta il partecipante selezionato a sinistra o a destra.
Alt+Su / GiùSposta il passaggio selezionato all'interno del suo ramo corrente.
Canc / BackspaceElimina la selezione al di fuori dei campi di testo, oppure usa il pulsante cestino dell'area di disegno. Le cascate dei partecipanti e la rimozione di gruppi/branch richiedono una conferma.
Esc durante un trascinamentoAnnulla l'anteprima senza modificare il modello.
RiordinaRipristina la spaziatura automatica senza modificare l'ordine o i rami; Annulla ripristina il posizionamento.
Partecipanti e passaggi30 partecipanti e 300 passaggi totali, inclusi frammenti e note.
Testo80 caratteri per nome partecipante, 240 per etichetta di messaggio/condizione/gruppo, 2.000 per nota.
File e cronologia4 MB di JSON importato, nome file cloud da 3 a 255 caratteri e 80 stati di annullamento.

Rivedi e risolvi i problemi

I controlli segnalano nomi vuoti, nomi di partecipanti duplicati, etichette di messaggi mancanti, rami vuoti, condizioni mancanti e un ordinamento di creazione o distruzione incoerente. Scegli un riscontro per rivelarne i Dettagli. Questi controlli non eseguono la conversazione né dimostrano il comportamento dell'API.

Se l'importazione fallisce, il diagramma corrente rimane intatto. La lettura di un file in sospeso più vecchio non può sostituire un documento più recente, un'importazione più recente o un modello modificato. Se il salvataggio sul cloud fallisce, tieni aperto il diagramma e scarica il JSON prima di uscire.

Usa le specifiche OMG UML per il significato della notazione di interazione. PlantUML e Mermaid hanno la propria sintassi di testo; i file generati sono esportazioni per tali strumenti, non un linguaggio di importazione di Erd Go.