Ir a la documentación

SIGA LA CONVERSACIÓN

Diagrama de secuencia: guía

Crea interacciones ordenadas de API y servicios con participantes, llamadas, respuestas, ramas y notas.

Participantes y mensajes → Diagrama de secuenciaAbrir diagrama de secuencia

Siga la conversación

El Diagrama de secuencia es un espacio de trabajo visual independiente para las interacciones entre personas, servicios y sistemas. Los participantes van de izquierda a derecha; el tiempo transcurre hacia abajo en la página. El esquema de flujo y el diagrama muestran el mismo modelo ordenado.

Elija la plantilla de solicitud de API para explorar un cliente, la API de pedidos, el servicio de autenticación y la base de datos. La plantilla verifica un token y utiliza un grupo if/else para devolver pedidos o una respuesta no autorizada. Elija Diagrama en blanco para crear su propia conversación.

Construir una interacción de API

  1. Añade participantes para el Cliente y la API. Selecciona uno en el panel de Flujo o en el diagrama para editar su nombre, símbolo, color y orden de izquierda a derecha.
  2. El lienzo en blanco le guía a través de los participantes y su primer mensaje. Los nombres nuevos y el texto del mensaje se seleccionan para que pueda escribir inmediatamente. Elija Mensaje, luego edite De, Para y Mensaje en Detalles. La barra Agregar muestra dónde irá el nuevo paso y quién envía el mensaje. Se añade un mensaje después del paso seleccionado, en la misma rama. Seleccionar un participante inicia el siguiente mensaje desde ese participante; un mensaje seleccionado proporciona sus puntos finales. Las notas añadidas desde un participante seleccionado utilizan ese ancla. Sin un paso seleccionado, se añade al flujo principal.
  3. Seleccione un mensaje y use Agregar respuesta después de este mensaje para invertir sus extremos y agregar una devolución discontinua. Arrastre los pasos para colocarlos en el tiempo; la vista previa muestra su destino. Los controles de arriba/abajo de Flujo reordenan dentro de la rama actual.
  4. Use Grupo → Si / si no, Opcional, Bucle o Paralelo. Seleccione una rama para editar su condición o añadir pasos allí. Añadir rama inserta antes de una alternativa de respaldo. En Flujo, cada rama tiene su propio botón +.
  5. Ejecute Comprobaciones, revise el diagrama y guarde o exporte el resultado. En teléfonos, use las pestañas Flujo, Diagrama y Detalles; Editar detalles abre el elemento seleccionado y Volver al diagrama regresa al lienzo.

Seleccionar, mover y agregar en el diagrama

Haga clic en el encabezado de un participante o línea de vida, mensaje, nota, borde de grupo o área de rama para seleccionarlo. Presione Enter o Espacio para abrir Detalles. Arrastre los encabezados de los participantes a la izquierda o derecha para ajustar el espaciado y el orden; arrastre mensajes, notas o grupos enteros verticalmente para establecer su orden temporal y dejar un espacio. En pantallas táctiles, arrastre el agarre visible; deslice en otro lugar para desplazarse.

La vista previa muestra el diagrama propuesto y nombra su rama de destino. Suelte en otra rama para transferir un paso, o utilice Mover paso a en Detalles. La creación y destrucción permanecen en el flujo principal; los grupos no pueden moverse dentro de sí mismos. Los arrastres se ajustan a 8 píxeles. Escapar o cancelar deja el modelo sin cambios; soltar realiza un cambio que se puede deshacer. Ordenar restaura el espaciado automático mientras mantiene su orden y ramas.

Haga clic en la barra Agregar, o en el escritorio arrastre Participante, Mensaje, Nota o un Grupo al diagrama. Las opciones de grupo explican If / else, Opcional, Bucle y Paralelo en lenguaje sencillo. La vista previa de soltar y el pie de página del lienzo nombran la rama de destino y muestran su posición en el tiempo. Los arrastres de la paleta comienzan con los dos primeros participantes; la dirección se muestra durante el arrastre. Elija los puntos finales del mensaje en Detalles; soltar cerca de una línea de vida no los cambia.

Haga clic en el lienzo vacío para borrar la selección. Arrastre el lienzo vacío o use el botón central del mouse para explorar mientras mantiene la selección. Se puede agregar un grupo antes que los participantes; su marcador de posición en el lienzo y el botón Flow + agregan al primer participante, luego ofrecen el primer mensaje.

Participantes y líneas de vida

Participante, Actor, Límite, Control, Entidad y Base de datos cambian el símbolo del encabezado. Son roles en una interacción, no tablas de base de datos. Los nombres y los colores de acento hexadecimales opacos opcionales se guardan con el diagrama.

Arrastra el encabezado de un participante para posicionarlo; los encabezados cercanos se apartan para mantenerse legibles. Mover a la izquierda y Mover a la derecha intercambian su lugar en el orden mostrado. Los puntos finales de los mensajes permanecen sin cambios. Detalles del participante ofrece las acciones Enviar mensaje y Añadir nota. Un mensaje al mismo participante se convierte automáticamente en una llamada a sí mismo; un diagrama de un solo participante ofrece esto explícitamente. Eliminar un participante también elimina los mensajes que lo involucran y quita su anclaje de las notas; Deshacer restaura el cambio completo.

Llamadas, respuestas y tiempos de vida

Llamadas, respuestas y tiempos de vida
TipoSignificado
Llamada síncronaLínea sólida y flecha rellena. El emisor espera por la operación llamada.
Mensaje asíncronoLínea sólida y flecha abierta. El emisor puede continuar sin esperar.
Respuesta / retornoLínea discontinua que regresa al llamador. Agregar respuesta invierte los puntos finales del mensaje seleccionado.
Crear participanteLa creación pertenece a la primera interacción de la línea de vida de destino. Su encabezado comienza en este mensaje.
Destruir participanteUna X marca la destrucción del objetivo. Esta debería ser su última interacción.
La creación y destrucción son compatibles en el flujo principal, fuera de los fragmentos. Las comprobaciones marcan el orden de vida inconsistente; el orden no válido mantiene visible la línea de vida completa para que las interacciones posteriores no se oculten.

Agrupar ramas sin perder su significado

If / else (alt) contiene de 2 a 6 ramas alternativas; se elige exactamente un operando coincidente. Opcional (opt) contiene una rama condicional. Bucle (loop) contiene una rama repetida; escriba la condición de iteración. Paralelo (par) contiene de 2 a 6 operandos cuyas interacciones pueden entrelazarse.

La pertenencia a la rama es explícita. Los botones de flujo y Alt+Arriba/Abajo mantienen un paso en su rama actual. Al arrastrar se puede transferir un mensaje, nota o grupo completo a la rama nombrada en la vista previa; Mover paso a ofrece la misma opción en Detalles. Los destinos no válidos se desactivan con un motivo, como mover un grupo dentro de sí mismo, exceder los cuatro niveles anidados o colocar la creación/destrucción dentro de una rama.

Cambiar un grupo de varias ramas a Opcional o Bucle pregunta antes de conservar solo su primera rama. Eliminar una rama pregunta antes de quitar sus pasos; si queda una rama, el grupo se vuelve Opcional, y eliminar la única rama quita el grupo. Eliminar un grupo quita todos sus pasos con confirmación. Deshacer restaura el cambio completo. La ubicación vertical de las ramas paralelas no implica un orden de ejecución entre ellas.

Notas, numeración y activaciones

Añade una nota y selecciona los participantes que debe abarcar. Las notas se ajustan dentro de su marco y se mueven con el orden de la secuencia. Úsalas para restricciones o explicaciones en lugar de poner un párrafo en una flecha de mensaje.

Los controles de vista gestionan los números de mensaje y las barras de activación automática. Estas opciones de apariencia se guardan y se incluyen en la exportación de la imagen. Los números proporcionan un orden de lectura; no son marcas de tiempo medidas ni un orden de ejecución total a través de ramas paralelas.

Las barras de activación se infieren de las llamadas síncronas y las respuestas dibujadas. Las llamadas a sí mismo pueden anidarse. Las ramas alternativas se calculan por separado para que las respuestas en una rama no cierren las llamadas en otra. Las respuestas faltantes dejan una activación abierta hasta el final de ese ámbito; esto es una ayuda visual más que un análisis de ejecución.

Los diagramas nuevos comienzan a una escala legible; los diagramas anchos se pueden desplazar horizontalmente. Ajustar el ancho del diagrama ofrece una vista general al tiempo que preserva la lectura vertical. Desplácese para explorar, use los controles de zoom o Ctrl/Command más desplazamiento para hacer zoom alrededor del puntero. Buscar busca nombres y tipos de participantes, mensajes y sus puntos finales, notas, descripciones de grupos y condiciones. Los pasos coincidentes mantienen su contexto de rama relevante; los ID y las posiciones están excluidos. Borrar o Escape restaura el Flujo completo, y un resultado vacío explica qué intentar. Al seleccionar un resultado de Flujo o Comprobaciones, o al agregar un elemento, su etiqueta se muestra sin cambiar el zoom. En teléfonos, esto sucede cuando regresa al Diagrama. El desplazamiento del lienzo, el zoom y la selección son vistas del espacio de trabajo fuera del documento y del historial de Deshacer.

Guardar, compartir e importar

Los nuevos diagramas permanecen en memoria. Guardar inicia sesión cuando es necesario y crea un archivo en la nube de diagrama de secuencia independiente. Archivo → Abrir diagramas de secuencia abre su propia lista de archivos. Guarde los últimos cambios antes de compartir un enlace público de solo lectura. Los visitantes públicos pueden inspeccionar y exportar, pero no pueden editar el archivo.

Archivo → Descargar JSON mantiene el documento editable completo, incluyendo las posiciones de los participantes y los espacios entre pasos. Los guardados en la nube y las exportaciones de imágenes también conservan esta disposición. Importar JSON acepta archivos de diagramas de secuencia de Erd Go versión 1 exportados de hasta 4 MB, valida el archivo completo antes de reemplazarlo y admite Deshacer. Los archivos antiguos mantienen el espaciado automático; las posiciones importadas superpuestas se muestran de forma segura. SQL, Diagrama de clases, Mermaid y PlantUML no son formatos de importación.

Archivo → Nuevo diagrama abre de nuevo el selector de En blanco/Plantilla. En blanco y Ejemplo de solicitud de API reemplazan un modelo existente con confirmación y Deshacer. Los diagramas no guardados solicitan confirmación antes de salir o recargar. No se escribe nada en el almacenamiento del navegador.

Exportar un diagrama o fuente de texto

Exportar crea PNG, JPEG, WebP, SVG vectorial independiente o PDF con respaldo de imagen. Elija Diagrama completo o Vista actual (abra primero el panel de Diagrama en teléfonos) y un ancho HD, 2K o 4K. Las dimensiones ráster están limitadas a 8192 píxeles por lado y 16 megapíxeles; los diagramas muy altos pueden reducirse. Use SVG para diagramas grandes escalables, o Vista actual para una sección legible.

Archivo → Exportar PlantUML / Mermaid previsualiza, copia y descarga texto local. El renderizador de texto controla su propio diseño y apariencia; los símbolos o colores de los participantes pueden diferir. JSON es el formato editable completo. No se envía ninguna fuente a un servidor de renderizado de terceros.

Mermaid / Ejemplo de texto de flujo de solicitud de 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
Construya este flujo visualmente o use la plantilla de solicitud de API. El ejemplo ilustra la exportación de texto; no se puede importar a Erd Go.

Atajos y límites

Atajos y límites
Acción o límiteComportamiento
Ctrl/Cmd+SGuardar en la nube; inicie sesión cuando se le solicite.
Ctrl/Cmd+KAbrir y enfocar Buscar en el panel de Flujo.
Ctrl/Cmd+Z / Shift+Z / Ctrl+YDeshacer / Rehacer fuera de los campos de texto. Los campos de texto conservan los atajos de edición nativos.
Enter / EspacioAbrir Detalles para el elemento del diagrama enfocado.
Alt+Izquierda / DerechaMueva el participante seleccionado a la izquierda o a la derecha.
Alt+Arriba / AbajoMueva el paso seleccionado dentro de su rama actual.
Eliminar / RetrocesoElimine la selección fuera de los campos de texto, o utilice el botón de papelera del lienzo. La eliminación de participantes en cascada y la eliminación de grupos/ramas solicitan confirmación.
Escape durante un arrastreCancelar la previsualización sin cambiar el modelo.
OrdenarRestablecer el espaciado automático sin cambiar el orden o las ramas; Deshacer restablece la ubicación.
Participantes y pasos30 participantes y 300 pasos en total, incluidos fragmentos y notas.
Texto80 caracteres por nombre de participante, 240 por etiqueta de mensaje/condición/grupo, 2000 por nota.
Archivos e historial4 MB de JSON importado, nombre de archivo en la nube de 3 a 255 caracteres y 80 estados de deshacer.

Revise y solucione problemas de

Las comprobaciones marcan nombres vacíos, nombres de participantes duplicados, etiquetas de mensajes faltantes, ramas vacías, condiciones faltantes y un orden de creación o destrucción inconsistente. Elija un hallazgo para ver sus Detalles. Estas comprobaciones no ejecutan la conversación ni prueban el comportamiento de la API.

Si la importación falla, su diagrama actual permanece intacto. Una lectura de archivo pendiente más antigua no puede reemplazar un documento más reciente, una importación más reciente o un modelo editado. Si el guardado en la nube falla, mantenga el diagrama abierto y descargue el JSON antes de salir.

Utilice la especificación UML de OMG para el significado de la notación de interacción. PlantUML y Mermaid tienen su propia sintaxis de texto; los archivos generados son exportaciones para esas herramientas, no un lenguaje de importación de Erd Go.