ACOMPANHE A CONVERSA
Diagrama de sequência: guia
Crie interações ordenadas de API e serviços com participantes, chamadas, respostas, ramificações e notas.
Siga a conversa
O Diagrama de sequência é um espaço de trabalho visual independente para interações entre pessoas, serviços e sistemas. Os participantes movem-se da esquerda para a direita; o tempo corre para baixo na página. O contorno do Fluxo e o diagrama mostram o mesmo modelo ordenado.
Escolha o modelo de pedido de API para explorar um cliente, a API de Encomendas, o serviço de Autenticação e a base de dados. O modelo verifica um token e utiliza um grupo if/else para devolver encomendas ou uma resposta não autorizada. Escolha Diagrama em branco para construir a sua própria conversa.
Construir uma interação de API
- Adicione participantes para o Client e a API. Selecione um no painel Flow ou no diagrama para editar o seu nome, símbolo, cor e ordem da esquerda para a direita.
- A tela em branco guia-o através dos participantes e da sua primeira mensagem. Os novos nomes e o texto da mensagem são selecionados para que possa escrever imediatamente. Escolha Mensagem e, em seguida, edite De, Para e Mensagem em Detalhes. A barra Adicionar mostra onde o novo passo irá ficar e quem envia a mensagem. Uma mensagem é adicionada após o passo selecionado, no mesmo ramo. Selecionar um participante inicia a mensagem seguinte a partir desse participante; uma mensagem selecionada fornece os seus pontos de extremidade. As notas adicionadas a partir de um participante selecionado utilizam essa âncora. Sem nenhum passo selecionado, é adicionada ao fluxo principal.
- Selecione uma mensagem e use Add reply after this message para inverter os seus endpoints e adicionar um retorno tracejado. Arraste os passos para os colocar no tempo; a pré-visualização mostra o seu destino. Os controlos up/down do Flow reordenam dentro do ramo atual.
- Utilize Grupo → Se / senão, Opcional, Ciclo ou Paralelo. Selecione uma ramificação para editar a sua condição ou adicionar passos aí. Adicionar ramificação insere antes de uma alternativa de fallback. No Fluxo, cada ramificação tem o seu próprio botão +.
- Execute as Verificações, reveja o diagrama e Salvar ou Exportar o resultado. Em telemóveis, utilize os separadores Fluxo, Diagrama e Detalhes; Editar detalhes abre o elemento selecionado e Voltar ao diagrama regressa à tela.
Selecionar, mover e adicionar no diagrama
Clique no cabeçalho de um participante ou linha de vida, mensagem, nota, borda de grupo ou área de ramificação para o selecionar. Prima Enter ou Espaço para abrir Detalhes. Arraste os cabeçalhos dos participantes para a esquerda ou direita para ajustar o espaçamento e a ordem; arraste mensagens, notas ou grupos inteiros verticalmente para definir a sua ordem temporal e deixar um espaço. Em ecrãs táteis, arraste a pega visível; deslize noutro local para navegar.
A pré-visualização mostra o diagrama proposto e nomeia a sua ramificação de destino. Mude para outra ramificação para transferir um passo, ou utilize Mover passo para em Detalhes. A criação e destruição permanecem no fluxo principal; os grupos não podem mover-se dentro de si próprios. Os arrastamentos alinham-se a 8 píxeis. Esc ou cancelar deixa o modelo inalterado; soltar faz uma alteração anulável. Organizar restaura o espaçamento automático mantendo a sua ordem e ramificações.
Clique na barra Adicionar ou, no ambiente de trabalho, arraste Participante, Mensagem, Nota ou um Grupo para o diagrama. As escolhas de Grupo explicam If / else, Opcional, Loop e Paralelo em linguagem simples. A pré-visualização de largar e o rodapé da tela nomeiam a ramificação de destino e mostram a sua posição no tempo. Os arrastamentos da paleta começam com os dois primeiros participantes; a direção é mostrada durante o arrastamento. Escolha os pontos terminais da mensagem em Detalhes; largar perto de uma linha de vida não os altera.
Clique na tela vazia para limpar a seleção. Arraste a tela vazia ou use o botão central do rato para explorar mantendo a seleção. Um grupo pode ser adicionado antes dos participantes; o seu marcador de posição na tela e o botão Fluxo + adicionam o primeiro participante e, em seguida, oferecem a primeira mensagem.
Participantes e linhas de vida
Participant, Actor, Boundary, Control, Entity e Database alteram o símbolo do cabeçalho. São papéis numa interação, não tabelas de base de dados. Os nomes e as cores de acento hexadecimais opacas opcionais são guardados com o diagrama.
Arraste o cabeçalho de um participante para o posicionar; os cabeçalhos próximos afastam-se para manter a legibilidade. Mover para a esquerda e Mover para a direita trocam o seu lugar na ordem exibida. Os pontos terminais das mensagens permanecem inalterados. Detalhes do Participante oferece as ações Enviar mensagem e Adicionar nota. Uma mensagem para o mesmo participante torna-se automaticamente uma chamada própria; um diagrama de um único participante oferece isto explicitamente. Eliminar um participante também remove as mensagens que o envolvem e remove a sua âncora das notas; Desfazer restaura a alteração completa.
Chamadas, respostas e tempos de vida
| Tipo | Significado |
|---|---|
| Chamada síncrona | Linha sólida e seta preenchida. O remetente aguarda pela operação chamada. |
| Mensagem assíncrona | Linha sólida e seta aberta. O remetente pode continuar sem aguardar. |
| Resposta / retorno | Linha tracejada a retornar ao chamador. Adicionar resposta inverte os pontos finais da mensagem selecionada. |
| Criar participante | A criação pertence à primeira interação da linha de vida de destino. O seu cabeçalho começa nesta mensagem. |
| Destruir participante | Um X marca a destruição do alvo. Esta deve ser a sua última interação. |
Agrupar ramos sem perder o seu significado
Se / senão (alt) contém 2–6 ramos alternativos; exatamente um operando correspondente é escolhido. Opcional (opt) contém um ramo condicional. Loop contém um ramo repetido; escreva a condição de iteração. Paralelo (par) contém 2–6 operandos cujas interações podem intercalar-se.
A pertença ao ramo é explícita. Os botões de fluxo e Alt+Cima/Baixo mantêm um passo no seu ramo atual. Arrastar pode transferir uma mensagem, nota ou um grupo inteiro para o ramo nomeado na pré-visualização; 'Mover passo para' oferece a mesma escolha em Detalhes. Destinos inválidos são desativados com um motivo, incluindo mover um grupo para dentro de si próprio, exceder quatro níveis aninhados ou colocar criação/destruição dentro de um ramo.
Alterar um grupo de vários ramos para Opcional ou Loop pergunta antes de manter apenas o seu primeiro ramo. Eliminar um ramo pergunta antes de remover os seus passos; se restar um ramo, o grupo torna-se Opcional, e eliminar o único ramo remove o grupo. Eliminar um grupo remove todos os seus passos com confirmação. Anular restaura a alteração completa. A colocação vertical de ramos paralelos não implica uma ordem de execução entre eles.
Notas, numeração e ativações
Adicione uma nota e selecione os participantes que esta deve abranger. As notas ajustam-se dentro da sua moldura e movem-se com a ordem da sequência. Utilize-as para restrições ou explicações em vez de colocar um parágrafo numa seta de mensagem.
A vista controla os números das mensagens e as barras de ativação automática. Estas opções de aparência são guardadas e incluídas na exportação de imagem. Os números fornecem uma ordem de leitura; não são marcas temporais medidas nem uma ordem de execução total entre ramificações paralelas.
As barras de ativação são inferidas a partir de chamadas síncronas e respostas desenhadas. As autochamadas podem ser aninhadas. Os ramos alternativos são calculados separadamente para que as respostas num ramo não fechem chamadas noutro. As respostas em falta deixam uma ativação aberta até ao fim desse âmbito; esta é uma ajuda visual e não uma análise de execução.
Novos diagramas começam numa escala legível; diagramas largos podem ser percorridos horizontalmente. Ajustar à largura do diagrama oferece uma visão geral preservando a leitura vertical. Percorra para explorar, use os controlos de zoom, ou Ctrl/Command mais scroll para fazer zoom em torno do ponteiro. Localizar pesquisa nomes e tipos de participantes, mensagens e os seus pontos terminais, notas, descrições de grupos e condições. Os passos correspondentes mantêm o contexto do seu ramo relevante; IDs e posições são excluídos. Limpar ou Escape restaura o Fluxo completo, e um resultado vazio explica o que tentar. Selecionar um resultado de Fluxo ou Verificações, ou adicionar um elemento, traz a sua etiqueta para a vista sem alterar o zoom. Em telemóveis, isto acontece quando regressa ao Diagrama. O deslocamento da tela, o zoom e a seleção são vistas da área de trabalho fora do documento e do histórico de Anular.
Salvar, partilhar e importar
Os novos diagramas permanecem na memória. Salvar inicia sessão quando necessário e cria um ficheiro na nuvem de diagrama de sequência independente. Ficheiro → Abrir diagramas de sequência abre a sua própria lista de ficheiros. Salvar as alterações mais recentes antes de partilhar uma ligação pública de apenas leitura. Os visualizadores públicos podem inspecionar e exportar, mas não podem editar o ficheiro.
Ficheiro → Descarregar JSON mantém o documento editável completo, incluindo as posições dos participantes e os intervalos entre passos. Os salvamentos na nuvem e as exportações de imagens também mantêm este posicionamento. Importar JSON aceita ficheiros exportados do diagrama de sequência Erd Go versão 1 até 4 MB, valida todo o ficheiro antes da substituição e suporta Desfazer. Ficheiros mais antigos mantêm o espaçamento automático; as posições importadas sobrepostas são apresentadas de forma segura. SQL, Diagrama de classes, Mermaid e PlantUML não são formatos de importação.
Ficheiro → Novo diagrama abre novamente o seletor de Vazio/Modelo. Vazio e exemplo de pedido de API substituem um modelo existente com confirmação e Anular. Diagramas não salvos solicitam confirmação antes de sair ou recarregar. Nada é escrito no armazenamento do navegador.
Exportar um diagrama ou fonte de texto
A exportação cria PNG, JPEG, WebP, SVG vetorial autónomo ou PDF baseado em imagem. Escolha Diagrama inteiro ou Vista atual (abra primeiro o painel do Diagrama nos telemóveis) e uma largura HD, 2K ou 4K. As dimensões raster estão limitadas a 8192 píxeis por lado e 16 megapíxeis; diagramas muito altos podem ser reduzidos. Utilize SVG para diagramas grandes escaláveis, ou Vista atual para uma secção legível.
Ficheiro → Exportar pré-visualizações PlantUML / Mermaid, copia e transfere texto local. O renderizador de texto controla o seu próprio esquema e aparência; os símbolos ou cores dos participantes podem diferir. JSON é o formato editável completo. Nenhum código-fonte é enviado para um servidor de renderização de terceiros.
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
endAtalhos e limites
| Ação ou limite | Comportamento |
|---|---|
| Ctrl/Cmd+S | Salvar na nuvem; inicie sessão quando solicitado. |
| Ctrl/Cmd+K | Abra e foque Localizar no painel Flow. |
| Ctrl/Cmd+Z / Shift+Z / Ctrl+Y | Desfazer / Refazer fora dos campos de texto. Os campos de texto mantêm os atalhos de edição nativos. |
| Enter / Espaço | Abrir Detalhes para o elemento do diagrama focado. |
| Alt+Esquerda / Direita | Mova o participante selecionado para a esquerda ou para a direita. |
| Alt+Cima / Baixo | Mova o passo selecionado dentro do seu ramo atual. |
| Eliminar / Backspace | Elimine a seleção fora dos campos de texto, ou utilize o botão do lixo da tela. Cascatas de participantes e remoção de grupos/ramos pedem confirmação. |
| Escape durante um arrastamento | Cancele a pré-visualização sem alterar o modelo. |
| Arrumar | Restaurar o espaçamento automático sem alterar a ordem ou os ramos; Anular restaura o posicionamento. |
| Participantes e passos | 30 participantes e 300 passos no total, incluindo fragmentos e notas. |
| Texto | 80 caracteres por nome de participante, 240 por etiqueta de mensagem/condição/grupo, 2.000 por nota. |
| Ficheiros e histórico | JSON importado de 4 MB, nome de ficheiro na nuvem de 3 a 255 carateres e 80 estados de anulação. |
Reveja e resolva problemas
As verificações sinalizam nomes vazios, nomes de participantes duplicados, etiquetas de mensagens em falta, ramos vazios, condições em falta e ordenação inconsistente de criação ou destruição. Escolha uma descoberta para revelar os seus Detalhes. Estas verificações não executam a conversa nem provam o comportamento da API.
Se a importação falhar, o seu diagrama atual permanece intacto. Uma leitura de ficheiro pendente mais antiga não pode substituir um documento mais recente, uma importação mais recente ou um modelo editado. Se o salvamento na nuvem falhar, mantenha o diagrama aberto e transfira o JSON antes de sair.
Utilize a especificação OMG UML para o significado da notação de interação. O PlantUML e o Mermaid têm a sua própria sintaxe de texto; os ficheiros gerados são exportações para essas ferramentas, não uma linguagem de importação do Erd Go.