VOLG HET GESPREK
Sequentiediagram: handleiding
Maak geordende API- en service-interacties met deelnemers, aanroepen, antwoorden, vertakkingen en notities.
Volg het gesprek
Sequentiediagram is een onafhankelijke visuele werkruimte voor interacties tussen mensen, services en systemen. Deelnemers lopen van links naar rechts; tijd loopt naar beneden op de pagina. De Flow-schets en het diagram tonen hetzelfde geordende model.
Kies de API-verzoeksjabloon om een client, Orders API, Auth-service en database te verkennen. De sjabloon verifieert een token en gebruikt een if/else-groep om bestellingen of een ongeautoriseerde reactie te retourneren. Kies Leeg diagram om uw eigen gesprek op te bouwen.
Bouw een API-interactie
- Voeg deelnemers toe voor de Client en API. Selecteer er één in het paneel Stroom of op het diagram om de naam, het symbool, de kleur en de volgorde van links naar rechts te bewerken.
- Het lege canvas begeleidt u door deelnemers en uw eerste bericht. Nieuwe namen en berichttekst worden geselecteerd zodat u onmiddellijk kunt typen. Kies Bericht, bewerk vervolgens Van, Aan en Bericht in Details. De knop Toevoegen toont waar de nieuwe stap zal komen en wie het bericht verzendt. Een bericht wordt toegevoegd na de geselecteerde stap, in dezelfde tak. Het selecteren van een deelnemer start het volgende bericht van die deelnemer; een geselecteerd bericht levert de eindpunten. Notities toegevoegd vanuit een geselecteerde deelnemer gebruiken die anker. Zonder geselecteerde stap wordt deze toegevoegd aan de hoofd-stroom.
- Selecteer een bericht en gebruik 'Voeg antwoord toe na dit bericht' om de eindpunten om te keren en een gestippelde retour toe te voegen. Versleep stappen om ze in de tijd te plaatsen; de preview toont de bestemming. De 'Flow' omhoog/omlaag-bedieningselementen sorteren binnen de huidige tak.
- Gebruik Groeperen → Als / anders, Optioneel, Lus, of Parallel. Selecteer een vertakking om de voorwaarde ervan te bewerken of stappen toe te voegen. Een vertakking toevoegen plaatst deze vóór een anders-fallback. In Flow heeft elke vertakking zijn eigen + knop.
- Voer controles uit, bekijk het diagram en sla het resultaat op of exporteer het. Gebruik op telefoons de tabbladen Flow, Diagram en Details; Details bewerken opent het geselecteerde element en Terug naar diagram keert terug naar het canvas.
Selecteren, verplaatsen en toevoegen op het diagram
Klik op een deelnemerskoptekst of levenslijn, bericht, notitie, groepsrand of takgebied om deze te selecteren. Druk op Enter of Spatie om Details te openen. Sleep deelnemerskopteksten naar links of rechts om de afstand en volgorde aan te passen; sleep berichten, notities of hele groepen verticaal om hun tijdvolgorde in te stellen en een hiaat achter te laten. Sleep op touchscreens de zichtbare greep; swip elders om te scrollen.
De preview toont het voorgestelde diagram en geeft de doelbranch ervan een naam. Sleep naar een andere branch om een stap over te zetten, of gebruik Stap verplaatsen naar in Details. Creatie en vernietiging blijven in de hoofd-flow; groepen kunnen niet binnen zichzelf worden verplaatst. Slepen klikt op 8 pixels. Ontsnappen of annuleren laat het model ongewijzigd; loslaten maakt één ongedaan te maken wijziging. Opruimen herstelt automatische afstand terwijl uw volgorde en branches behouden blijven.
Klik op de toevoegbalk, of sleep op desktop Deelnemer, Bericht, Notitie of een Groep naar het diagram. Groepskeuzes leggen Als / anders, Optioneel, Lus en Parallel in duidelijke taal uit. Het drop-voorbeeld en de canvasvoettekst benoemen de doeltak en tonen de positie in de tijd. Paletsleepacties beginnen met de eerste twee deelnemers; de richting wordt getoond tijdens het slepen. Kies bericht-eindpunten in Details; neerzetten in de buurt van een levenslijn verandert deze niet.
Klik op een leeg canvas om de selectie te wissen. Sleep het lege canvas of gebruik de middelste muisknop om rond te kijken met behoud van de selectie. Er kan een groep worden toegevoegd vóór deelnemers; de canvasplaatshouder en de Stroom + knop voegen de eerste deelnemer toe en bieden dan het eerste bericht.
Participanten en levenslijnen
Participant, Actor, Boundary, Control, Entity en Database wijzigen het koptekstsymbool. Dit zijn rollen in een interactie, geen databasetabellen. Namen en optionele ondoorzichtige hex-accentkleuren worden opgeslagen bij het diagram.
Sleep een deelnemerskoptekst om deze te positioneren; nabijgelegen kopteksten schuiven opzij om leesbaar te blijven. Verplaats naar links en Verplaats naar rechts wisselen de plaats in de weergegeven volgorde. Berichteindpunten blijven ongewijzigd. Deelnemerdetails biedt acties voor Bericht verzenden en Notitie toevoegen. Een bericht aan dezelfde deelnemer wordt automatisch een zelf-aanroep; een diagram met één deelnemer biedt dit expliciet aan. Het verwijderen van een deelnemer verwijdert ook berichten die daarbij betrokken zijn en verwijdert het anker uit notities; Ongedaan maken herstelt de volledige wijziging.
Oproepen, antwoorden en levensduur
| Soort | Betekenis |
|---|---|
| Synchrone aanroep | Ononderbroken lijn en gevulde pijl. De afzender wacht op de aangeroepen bewerking. |
| Asynchroon bericht | Ononderbroken lijn en open pijl. De afzender kan doorgaan zonder te wachten. |
| Antwoorden / retourneren | Gedempte lijn die terugkeert naar de aanroeper. 'Antwoord toevoegen' keert de geselecteerde bericht-eindpunten om. |
| Deelnemer maken | Aanmaak hoort bij de eerste interactie van de doellevenslijn. De header begint bij dit bericht. |
| Deelnemer vernietigen | Een X markeert de vernietiging van het doel. Dit moet de laatste interactie zijn. |
Groepeer takken zonder hun betekenis te verliezen
If / else (alt) bevat 2–6 alternatieve takken; precies één overeenkomende operand wordt gekozen. Optioneel (opt) bevat één voorwaardelijke tak. Lus bevat één herhaalde tak; schrijf de iteratievoorwaarde. Parallel (par) bevat 2–6 operanden waarvan de interacties elkaar kunnen afwisselen.
Lidmaatschap van een aftakking is expliciet. Stroomknoppen en Alt+Omhoog/Omlaag houden een stap in zijn huidige aftakking. Slepen kan een bericht, notitie of hele groep overdragen naar de aftakking genoemd in de voorbeeldweergave; Stap verplaatsen naar biedt dezelfde keuze in Details. Ongeldige bestemmingen worden uitgeschakeld met een reden, waaronder het verplaatsen van een groep in zichzelf, het overschrijden van vier geneste niveaus, of het plaatsen van creatie/vernietiging binnen een aftakking.
Het wijzigen van een groep met meerdere aftakkingen in Optioneel of Lus vraagt om bevestiging voordat alleen de eerste aftakking wordt behouden. Het verwijderen van een aftakking vraagt of de stappen moeten worden verwijderd; als er één aftakking overblijft, wordt de groep Optioneel, en het verwijderen van de enige aftakking verwijdert de groep. Het verwijderen van een groep verwijdert al zijn stappen met bevestiging. Ongedaan maken herstelt de volledige wijziging. Verticale plaatsing van parallelle aftakkingen impliceert geen uitvoeringsvolgorde tussen hen.
Notities, nummering en activaties
Voeg een notitie toe en selecteer de deelnemers die deze moet overspannen. Notities lopen binnen hun kader en bewegen mee met de sequentievolgorde. Gebruik ze voor beperkingen of uitleg in plaats van een alinea op een berichtpijl te plaatsen.
Weergave van besturingsberichten en automatische activeringsbalken. Deze weergaveopties worden opgeslagen en opgenomen in de beeldexport. Nummers geven een leesvolgorde aan; het zijn geen gemeten tijdstempels of een totale uitvoeringsvolgorde over parallelle takken.
Activatiebalken worden afgeleid van synchrone oproepen en getekende antwoorden. Zelf-oproepen kunnen nesten. Alternatieve takken worden apart berekend zodat antwoorden in de ene tak geen oproepen in een andere sluiten. Ontbrekende antwoorden laten een activatie open tot het einde van dat bereik; dit is een visueel hulpmiddel in plaats van uitvoeringsanalyse.
Nieuwe diagrammen beginnen op een leesbare schaal; brede diagrammen kunnen horizontaal worden verschoven. 'Pas diagrambreedte aan' geeft een overzicht met behoud van verticale leesbaarheid. Scroll om te verkennen, gebruik de zoombediening of Ctrl/Command plus scroll om rond de cursor te zoomen. Zoeken vindt deelnemernamen en -typen, berichten en hun eindpunten, notities, groepsbeschrijvingen en voorwaarden. Overeenkomende stappen behouden hun relevante takcontext; ID's en posities zijn uitgesloten. Wissen of Esc herstelt de volledige stroom en een leeg resultaat legt uit wat u kunt proberen. Het selecteren van een stroom- of controleresultaat, of het toevoegen van een element, brengt het label in beeld zonder de zoom te wijzigen. Op telefoons gebeurt dit wanneer u terugkeert naar Diagram. Canvas scrollen, zoomen en selectie zijn werkruimteweergaven buiten het document en de ongedaan maken-geschiedenis.
Opslaan, delen en importeren
Nieuwe diagrammen blijven in het geheugen. Opslaan meldt indien nodig aan en maakt een onafhankelijk sequentiediagram-cloudbestanden aan. Bestand → Open sequentiediagrammen opent de eigen bestandslijst. Sla de laatste wijzigingen op voordat je een alleen-lezen openbare link deelt. Openbare kijkers kunnen het bestand inspecteren en exporteren maar kunnen het niet bewerken.
Bestand → JSON downloaden behoudt het volledige bewerkbare document, inclusief posities van deelnemers en stapgaten. Cloud-opslag en afbeeldingsexports behouden deze plaatsing ook. JSON importeren accepteert geëxporteerde Erd Go sequentiediagramversie 1-bestanden tot 4 MB, valideert het hele bestand vóór vervanging en ondersteunt Ongedaan maken. Oudere bestanden behouden automatische afstand; overlappende geïmporteerde posities worden veilig weergegeven. SQL, Klassendiagram, Mermaid en PlantUML zijn geen importformaten.
Bestand → Nieuw diagram opent de kiezer voor Leeg/Sjabloon opnieuw. Leeg en API-verzoekvoorbeeld vervangen een bestaand model na bevestiging en met behulp van Ongedaan maken. Niet-opgeslagen diagrammen tonen een waarschuwing bij het verlaten of herladen. Er wordt niets naar de browseropslag geschreven.
Exporteer een diagram of tekstbron
Exporteren maakt een PNG, JPEG, WebP, zelfstandige vector-SVG of afbeeldings-PDF. Kies Hele diagram of Huidige weergave (open eerst het diagrampaneel op telefoons) en een HD-, 2K- of 4K-breedte. Rasterafmetingen zijn beperkt tot 8192 pixels per zijde en 16 megapixels; zeer hoge diagrammen kunnen worden verkleind. Gebruik SVG voor schaalbare grote diagrammen of Huidige weergave voor een leesbaar gedeelte.
Bestand → PlantUML / Mermaid exporteren toont voorbeelden, kopieert en downloadt lokale tekst. De tekst-renderer beheert zijn eigen lay-out en uiterlijk; symbolen of kleuren van deelnemers kunnen afwijken. JSON is het volledige bewerkbare formaat. Er wordt geen broncode verzonden naar een renderingserver van een derde partij.
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
endSnelkoppelingen en limieten
| Actie of limiet | Gedrag |
|---|---|
| Ctrl/Cmd+S | Opslaan naar cloud; meld u aan wanneer daarom wordt gevraagd. |
| Ctrl/Cmd+K | Open en focus Zoeken in het stroompaneel. |
| Ctrl/Cmd+Z / Shift+Z / Ctrl+Y | Ongedaan maken / Opnieuw buiten tekstvelden. Tekstvelden behouden native bewerkingssnelkoppelingen. |
| Enter / Spatie | Open Details voor het gefocusde diagramelement. |
| Alt+Links / Rechts | Verplaats de geselecteerde deelnemer naar links of rechts. |
| Alt+Omhoog / Omlaag | Verplaats de geselecteerde stap binnen zijn huidige tak. |
| Verwijderen / Backspace | Verwijder de selectie buiten tekstvelden, of gebruik de prullenbakknop op het canvas. Deelnemerscascades en het verwijderen van groepen/takken vragen om bevestiging. |
| Escape tijdens een sleepbewerking | Annuleer het voorbeeld zonder het model te wijzigen. |
| Opruimen | Herstel automatische afstand zonder volgorde of vertakkingen te wijzigen; Ongedaan maken herstelt de plaatsing. |
| Participanten en stappen | 30 deelnemers en in totaal 300 stappen, inclusief fragmenten en notities. |
| Tekst | 80 tekens per deelnemersnaam, 240 per bericht-/voorwaarde-/groepsetiket, 2.000 per notitie. |
| Bestanden en geschiedenis | 4 MB geïmporteerde JSON, een cloudbestandsnaam van 3–255 tekens en 80 ongedaangemaakstaten. |
Controleren en oplossen van problemen
Controles markeren lege namen, dubbele deelnemersnamen, ontbrekende berichtlabels, lege takken, ontbrekende voorwaarden en inconsistente aanmaak- of vernietigingsvolgorde. Kies een bevinding om de Details ervan te onthullen. Deze controles voeren het gesprek niet uit en bewijzen het API-gedrag niet.
Als het importeren mislukt, blijft je huidige diagram intact. Een ouder openstaand bestand dat wordt gelezen kan een nieuwere document, nieuwere import of bewerkt model niet overschrijven. Als opslaan in de cloud mislukt, laat het diagram dan open en download de JSON voordat je weggaat.
Gebruik de OMG UML-specificatie voor de betekenis van interactienotatie. PlantUML en Mermaid hebben hun eigen tekstsyntaxis; de gegenereerde bestanden zijn exports voor die tools, geen Erd Go-importtaal.