SUIVRE LA CONVERSATION
Diagramme de séquence : guide
Créez des interactions API et services ordonnées avec participants, appels, réponses, branches et notes.
Suivre la conversation
Le Diagramme de séquence est un espace de travail visuel indépendant pour les interactions entre personnes, services et systèmes. Les participants s'étendent de gauche à droite ; le temps s'écoule vers le bas de la page. Le plan du Flux et le diagramme affichent le même modèle ordonné.
Choisissez le modèle de Requête API pour explorer un client, l'API Orders, le service Auth et la base de données. Le modèle vérifie un jeton et utilise un groupe if/else pour renvoyer des commandes ou une réponse non autorisée. Choisissez Diagramme vide pour construire votre propre conversation.
Construire une interaction d'API
- Ajoutez des participants pour le client et l'API. Sélectionnez-en un dans le panneau Flux ou sur le diagramme pour modifier son nom, son symbole, sa couleur et son ordre de gauche à droite.
- Le canevas vide vous guide à travers les participants et votre premier message. Les nouveaux noms et le texte du message sont sélectionnés pour que vous puissiez taper immédiatement. Choisissez Message, puis modifiez Source, Destination et Message dans les Détails. La barre d'ajout indique où la nouvelle étape ira et qui envoie le message. Un message est ajouté après l'étape sélectionnée, dans la même branche. La sélection d'un participant démarre le message suivant à partir de ce participant ; un message sélectionné fournit ses points de terminaison. Les notes ajoutées à partir d'un participant sélectionné utilisent cette ancre. S'il n'y a pas d'étape sélectionnée, elle est ajoutée au flux principal.
- Sélectionnez un message et utilisez Ajouter une réponse après ce message pour inverser ses extrémités et ajouter un retour en pointillé. Faites glisser les étapes pour les placer dans le temps ; l'aperçu montre leur destination. Les commandes haut/bas de Flux réorganisent au sein de la branche actuelle.
- Utilisez Groupe → Si / sinon, Optionnel, Boucle ou Parallèle. Sélectionnez une branche pour modifier sa condition ou y ajouter des étapes. Ajouter une branche s'insère avant un repli sinon (else). Dans Flux, chaque branche a son propre bouton +.
- Exécutez les vérifications, examinez le diagramme, puis enregistrez ou exportez le résultat. Sur les téléphones, utilisez les onglets Flux, Diagramme et Détails ; Modifier les détails ouvre l'élément sélectionné et Retour au diagramme revient au canevas.
Sélectionner, déplacer et ajouter sur le diagramme
Cliquez sur l'en-tête d'un participant ou sa ligne de vie, un message, une note, la bordure d'un groupe ou la zone d'une branche pour le sélectionner. Appuyez sur Entrée ou Espace pour ouvrir les Détails. Glissez les en-têtes de participants vers la gauche ou la droite pour ajuster l'espacement et l'ordre ; glissez les messages, les notes ou des groupes entiers verticalement pour définir leur ordre temporel et laisser un espace. Sur les écrans tactiles, glissez la poignée visible ; balayez ailleurs pour faire défiler.
L'aperçu affiche jusqu'à 100 lignes. Le SQL généré inclut toujours toutes les lignes non vides de la feuille de calcul sélectionnée. Déposez-la dans une autre branche pour transférer une étape, ou utilisez Déplacer l'étape vers dans Détails. La création et la destruction restent dans le flux principal ; les groupes ne peuvent pas se déplacer à l'intérieur d'eux-mêmes. Les déplacements s'accrochent à 8 pixels. Échap ou l'annulation laisse le modèle inchangé ; le relâchement effectue une modification annulable. Nettoyer restaure l'espacement automatique tout en conservant votre ordre et vos branches.
Cliquez sur la barre Ajouter, ou sur bureau, glissez Participant, Message, Note ou un Groupe sur le diagramme. Les choix de groupes expliquent If / else, Optionnel, Boucle et Parallèle en langage clair. L'aperçu du dépôt et le pied de page du canevas nomment la branche de destination et affichent sa position dans le temps. Les glissements de la palette commencent avec les deux premiers participants ; la direction est affichée pendant le glissement. Choisissez les points de terminaison des messages dans les Détails ; déposer près d'une ligne de vie ne les modifie pas.
Cliquez sur un canevas vide pour effacer la Sélection. Glissez sur le canevas vide ou utilisez le bouton du milieu de la souris pour explorer tout en conservant la Sélection. Un groupe peut être ajouté avant les participants ; son espace réservé sur le canevas et le bouton + du flux ajoutent le premier participant, puis proposent le premier message.
Participants et lignes de vie
Participant, Acteur, Limite, Contrôle, Entité et Base de données modifient le symbole d'en-tête. Ce sont des rôles dans une interaction, et non des tables de base de données. Les noms et les couleurs d'accentuation hexadécimales opaques optionnelles sont enregistrés avec le diagramme.
Faites glisser l'en-tête d'un participant pour le positionner ; les en-têtes voisins s'écartent pour rester lisibles. Déplacer vers la gauche et Déplacer vers la droite échangent sa place dans l'ordre affiché. Les extrémités des messages restent inchangées. Détails du participant propose les actions Envoyer un message et Ajouter une note. Un message adressé au même participant devient automatiquement un auto-appel ; un diagramme à un seul participant le propose explicitement. La suppression d'un participant supprime également les messages le concernant et retire son ancrage des notes ; Annuler restaure la modification complète.
Appels, réponses et durées de vie
| Type | Signification |
|---|---|
| Appel synchrone | Ligne pleine et flèche pleine. L'expéditeur attend l'opération appelée. |
| Message asynchrone | Ligne pleine et flèche ouverte. L'expéditeur peut continuer sans attendre. |
| Réponse / retour | Ligne pointillée retournant à l'appelant. Ajouter une réponse inverse les extrémités du message sélectionné. |
| Créer un participant | La création appartient à la première interaction de la ligne de vie cible. Son en-tête commence à ce message. |
| Détruire le participant | Un X marque la destruction de la cible. Cela devrait être sa dernière interaction. |
Grouper des branches sans perdre leur signification
If / else (alt) contient 2 à 6 branches alternatives ; exactement un opérande correspondant est choisi. Optional (opt) contient une branche conditionnelle. Loop contient une branche répétée ; écrivez la condition d'itération. Parallel (par) contient 2 à 6 opérandes dont les interactions peuvent s'entremêler.
L'appartenance à une branche est explicite. Les boutons de flux et Alt + Flèche haut/bas maintiennent une étape dans sa branche actuelle. Le glisser-déposer peut transférer un message, une note ou un groupe entier vers la branche nommée dans l'aperçu ; Déplacer l'étape vers offre le même choix dans les Détails. Les destinations non valides sont désactivées avec un motif, notamment le déplacement d'un groupe à l'intérieur de lui-même, le dépassement de quatre niveaux d'imbrication ou le placement d'une création/destruction à l'intérieur d'une branche.
La transformation d'un groupe à branches multiples en Optionnel ou Boucle demande confirmation avant de ne conserver que sa première branche. La suppression d'une branche demande confirmation avant de supprimer ses étapes ; s'il ne reste qu'une seule branche, le groupe devient Optionnel, et la suppression de l'unique branche supprime le groupe. La suppression d'un groupe supprime toutes ses étapes avec confirmation. Annuler restaure la modification complète. Le placement vertical des branches parallèles n'indique pas d'ordre d'exécution entre elles.
Notes, numérotation et activations
Ajoutez une note et sélectionnez les participants qu'elle doit couvrir. Les notes s'ajustent dans leur cadre et se déplacent avec l'ordre de la séquence. Utilisez-les pour des contraintes ou des explications plutôt que de placer un paragraphe sur une flèche de message.
Les commandes de vue gèrent les numéros de message et les barres d'activation automatique. Ces options d'affichage sont enregistrées et incluses dans l'exportation d'image. Les numéros fournissent un ordre de lecture ; ce ne sont pas des horodatages mesurés ni un ordre d'exécution total sur des branches parallèles.
Les barres d'activation sont déduites des appels synchrones et des réponses dessinées. Les auto-appels peuvent s'imbriquer. Les branches alternatives sont calculées séparément afin que les réponses d'une branche ne ferment pas les appels dans une autre. Les réponses manquantes laissent une activation ouverte jusqu'à la fin de cette portée ; il s'agit d'une aide visuelle plutôt que d'une analyse d'exécution.
Les nouveaux diagrammes démarrent à une échelle lisible ; les diagrammes larges peuvent défiler horizontalement. Ajuster la largeur du diagramme donne une vue d'ensemble tout en préservant la lecture verticale. Faites défiler pour explorer, utilisez les commandes de zoom, ou maintenez Ctrl/Commande et faites défiler pour zoomer autour du pointeur. La recherche (Find) parcourt les noms et types des participants, les messages et leurs extrémités, les notes, les descriptions de groupe et les conditions. Les étapes correspondantes conservent le contexte de leur branche pertinente ; les identifiants et les positions sont exclus. Effacer ou Échap (Escape) restaure l'ensemble du flux, et un résultat vide explique quoi essayer. La sélection d'un résultat de flux ou de vérifications, ou l'ajout d'un élément, amène son étiquette en vue sans modifier le zoom. Sur les téléphones, cela se produit lorsque vous revenez au diagramme. Le défilement du canevas, le zoom et la sélection sont des vues de l'espace de travail situées en dehors du document et de l'historique d'annulation.
Enregistrer, partager et importer
Les nouveaux diagrammes restent en mémoire. L'enregistrement se connecte si nécessaire et crée un fichier cloud de diagramme de séquence indépendant. Fichiers → Ouvrir les diagrammes de séquence ouvre sa propre liste de fichiers. Enregistrez les dernières modifications avant de partager un lien public en lecture seule. Les spectateurs publics peuvent inspecter et exporter, mais ne peuvent pas modifier le fichier.
Fichier → Télécharger JSON conserve l'intégralité du document modifiable, y compris les positions des participants et les espaces entre les étapes. Les enregistrements cloud et les exportations d'images conservent également cet emplacement. Importer JSON accepte les fichiers de diagramme de séquence Erd Go version 1 exportés jusqu'à 4 Mo, valide l'ensemble du fichier avant le remplacement et prend en charge Annuler. Les fichiers plus anciens conservent l'espacement automatique ; les positions importées qui se chevauchent s'affichent en toute sécurité. SQL, Diagramme de classes, Mermaid et PlantUML ne sont pas des formats d'importation.
Fichier → Nouveau diagramme ouvre à nouveau le sélecteur Vide/Modèle. Vide et Exemple de requête API remplacent un modèle existant avec confirmation et Annuler. Les diagrammes non enregistrés demandent confirmation avant de quitter ou de recharger. Rien n'est écrit dans le stockage du navigateur.
Exporter un diagramme ou une source textuelle
L'exportation crée un fichier PNG, JPEG, WebP, SVG vectoriel autonome ou PDF pris en charge par une image. Choisissez Intégralité du diagramme ou Vue actuelle (ouvrez d'abord le panneau Diagramme sur les téléphones) et une largeur HD, 2K ou 4K. Les dimensions raster sont limitées à 8192 pixels par côté et 16 mégapixels ; les diagrammes très hauts peuvent être réduits. Utilisez SVG pour les grands diagrammes évolutifs, ou Vue actuelle pour une section lisible.
Fichier → Exporter PlantUML / Mermaid prévisualise, copie et télécharge du texte local. Le moteur de rendu de texte contrôle sa propre mise en page et son apparence ; les symboles ou les couleurs des participants peuvent différer. Le JSON est le format modifiable complet. Aucune source n'est envoyée à un serveur de rendu tiers.
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
endRaccourcis et limites
| Action ou limite | Comportement |
|---|---|
| Ctrl/Cmd+S | Enregistrer sur le cloud ; connectez-vous lorsque vous y êtes invité. |
| Ctrl/Cmd+K | Ouvrez et activez Rechercher dans le panneau Flux. |
| Ctrl/Cmd+Z / Shift+Z / Ctrl+Y | Annuler / Rétablir en dehors des champs de texte. Les champs de texte conservent les raccourcis d'édition natifs. |
| Entrée / Espace | Ouvrir les détails de l'élément de diagramme sélectionné. |
| Alt + Gauche / Droite | Déplacer le participant sélectionné vers la gauche ou la droite. |
| Alt + Haut / Bas | Déplacer l'étape sélectionnée au sein de sa branche actuelle. |
| Supprimer / Retour arrière | Supprimez la sélection en dehors des champs de texte, ou utilisez le bouton corbeille du canevas. Les cascades de participants et la suppression de groupes/branches demandent confirmation. |
| Échap pendant un déplacement | Annuler l'aperçu sans modifier le modèle. |
| Nettoyer | Rétablit l'espacement automatique sans modifier l'ordre ou les branches ; Annuler rétablit le placement. |
| Participants et étapes | 30 participants et 300 étapes au total, y compris les fragments et les notes. |
| Texte | 80 caractères par nom de participant, 240 par libellé de message/condition/groupe, 2 000 par note. |
| Fichiers et historique | JSON importé de 4 Mo, nom de fichier cloud de 3 à 255 caractères et 80 états d'annulation. |
Examiner et dépanner
Les vérifications signalent les noms vides, les noms de participants en double, les étiquettes de message manquantes, les branches vides, les conditions manquantes et les ordres de création ou de destruction incohérents. Choisissez une constatation pour afficher ses Détails. Ces vérifications n'exécutent pas la conversation et ne prouvent pas le comportement de l'API.
Si l'importation échoue, votre diagramme actuel reste intact. La lecture d'un ancien fichier en attente ne peut pas remplacer un document plus récent, une importation plus récente ou un modèle modifié. Si l'enregistrement dans le cloud échoue, gardez le diagramme ouvert et téléchargez le JSON avant de quitter.
Utilisez la spécification OMG UML pour la signification de la notation d'interaction. PlantUML et Mermaid ont leur propre syntaxe textuelle ; les fichiers générés sont des exportations pour ces outils, et non un langage d'importation Erd Go.