ŚLEDŹ ROZMOWĘ
Diagram sekwencji — poradnik
Twórz uporządkowane interakcje API i usług z uczestnikami, wywołaniami, odpowiedziami, gałęziami i notatkami.
Śledź rozmowę
Diagram sekwencji to niezależny wizualny obszar roboczy dla interakcji między ludźmi, usługami i systemami. Uczestnicy są rozmieszczeni od lewej do prawej; czas płynie w dół strony. Zarys przepływu i diagram pokazują ten sam uporządkowany model.
Wybierz szablon żądania API, aby zbadać klienta, API zamówień, usługę Auth i bazę danych. Szablon weryfikuje token i używa grupy if/else, aby zwrócić zamówienia lub odpowiedź o braku autoryzacji. Wybierz Pusty diagram, aby zbudować własną konwersację.
Zbuduj interakcję API
- Dodaj uczestników dla Client i API. Wybierz jednego w panelu Flow lub na diagramie, aby edytować jego nazwę, symbol, kolor i kolejność od lewej do prawej.
- Puste płótno prowadzi Cię przez uczestników i Twoją pierwszą wiadomość. Nowe nazwy i tekst wiadomości są zaznaczone, dzięki czemu możesz natychmiast pisać. Wybierz Wiadomość, a następnie edytuj Od, Do i Wiadomość w Szczegółach. Pasek Dodaj pokazuje, gdzie trafi nowy krok i kto wysyła wiadomość. Wiadomość jest dodawana po wybranym kroku, w tej samej gałęzi. Wybranie uczestnika rozpoczyna kolejną wiadomość od tego uczestnika; wybrana wiadomość dostarcza swoje punkty końcowe. Notatki dodane od wybranego uczestnika używają tego zakotwiczenia. Bez wybranego kroku wiadomość jest dodawana do głównego przepływu.
- Wybierz wiadomość i użyj opcji Dodaj odpowiedź po tej wiadomości, aby odwrócić jej punkty końcowe i dodać przerywaną linię powrotu. Przeciągaj kroki, aby umieścić je w czasie; podgląd pokazuje ich cel. Kontrolki góra/dół w sekcji Przepływ zmieniają kolejność w obrębie bieżącej gałęzi.
- Użyj Grupa → If / else, Opcjonalne, Pętla lub Równoległe. Wybierz gałąź, aby edytować jej warunek lub dodać tam kroki. Dodaj gałąź wstawia przed elementem rezerwowym else. W Przepływie każda gałąź ma swój własny przycisk +.
- Uruchom Sprawdzenia, przejrzyj diagram i zapisz lub eksportuj wynik. Na telefonach używaj kart Przepływ, Diagram i Szczegóły; Edytuj szczegóły otwiera wybrany element, a Powrót do diagramu wraca do kanwy.
Zaznaczaj, przesuwaj i dodawaj na diagramie
Kliknij nagłówek uczestnika lub linię życia, wiadomość, notatkę, obramowanie grupy lub obszar gałęzi, aby go zaznaczyć. Naciśnij Enter lub Spację, aby otworzyć Szczegóły. Przeciągnij nagłówki uczestników w lewo lub w prawo, aby dostosować odstępy i kolejność; przeciągnij wiadomości, notatki lub całe grupy pionowo, aby ustawić ich kolejność czasową i pozostawić przerwę. Na ekranach dotykowych przeciągnij widoczny uchwyt; przesuń palcem w innym miejscu, aby przewijać.
Podgląd pokazuje proponowany diagram i nazywa jego gałąź docelową. Upuść na inną gałąź, aby przenieść krok, lub użyj opcji Przenieś krok do w Szczegółach. Tworzenie i niszczenie pozostają w głównym przepływie; grupy nie mogą przemieszczać się wewnątrz samych siebie. Przeciąganie przyciąga do 8 pikseli. Klawisz Escape lub anulowanie pozostawia model bez zmian; zwolnienie przycisku myszy wprowadza jedną zmianę, którą można cofnąć. Funkcja Uporządkuj przywraca automatyczne odstępy, zachowując kolejność i gałęzie.
Kliknij pasek Dodaj lub na komputerze przeciągnij Uczestnika, Wiadomość, Notatkę lub Grupę na diagram. Opcje grup wyjaśniają If / else, Opcjonalne, Pętlę i Równoległe w prostym języku. Podgląd upuszczania i stopka obszaru roboczego nazywają gałąź docelową i pokazują jej pozycję w czasie. Przeciąganie z palety zaczyna się od pierwszych dwóch uczestników; kierunek jest pokazywany podczas przeciągania. Wybierz punkty końcowe wiadomości w Szczegółach; upuszczenie w pobliżu linii życia nie zmienia ich.
Kliknij pusty obszar roboczy, aby wyczyścić zaznaczenie. Przeciągnij pusty obszar roboczy lub użyj środkowego przycisku myszy, aby eksplorować, zachowując zaznaczenie. Grupę można dodać przed uczestnikami; jej symbol zastępczy na obszarze roboczym i przycisk Flow + dodają pierwszego uczestnika, a następnie oferują pierwszą wiadomość.
Uczestnicy i linie życia
Participant, Actor, Boundary, Control, Entity oraz Database zmieniają symbol nagłówka. Są to role w interakcji, a nie tabele bazy danych. Nazwy i opcjonalne nieprzezroczyste kolory akcentów hex są zapisywane wraz z diagramem.
Przeciągnij nagłówek uczestnika, aby go wypozycjonować; sąsiednie nagłówki odsuną się, aby zachować czytelność. Przesuń w lewo i Przesuń w prawo zamieniają jego miejsce w wyświetlanej kolejności. Punkty końcowe wiadomości pozostają bez zmian. Szczegóły uczestnika oferują akcje Wyślij wiadomość i Dodaj notatkę. Wiadomość do tego samego uczestnika automatycznie staje się wywołaniem zwrotnym; diagram z jednym uczestnikiem oferuje to jawnie. Usunięcie uczestnika usuwa również wiadomości z nim związane oraz jego zakotwiczenie w notatkach; Cofnij przywraca kompletną zmianę.
Wywołania, odpowiedzi i czasy życia
| Rodzaj | Znaczenie |
|---|---|
| Wywołanie synchroniczne | Linia ciągła i wypełniona strzałka. Nadawca czeka na wywołaną operację. |
| Komunikat asynchroniczny | Linia ciągła i otwarta strzałka. Nadawca może kontynuować bez czekania. |
| Odpowiedź / zwrot | Linia przerywana powracająca do wywołującego. Dodaj odpowiedź odwraca punkty końcowe wybranej wiadomości. |
| Utwórz uczestnika | Tworzenie należy do pierwszej interakcji docelowej linii życia. Jej nagłówek zaczyna się od tej wiadomości. |
| Zniszcz uczestnika | Znak X oznacza zniszczenie celu. Powinna to być jego ostatnia interakcja. |
Grupuj gałęzie bez utraty ich znaczenia
If / else (alt) zawiera 2–6 gałęzi alternatywnych; wybierany jest dokładnie jeden pasujący operand. Optional (opt) zawiera jedną gałąź warunkową. Loop zawiera jedną gałąź powtarzaną; wpisz warunek iteracji. Parallel (par) zawiera 2–6 operandów, których interakcje mogą się przeplatać.
Przynależność do gałęzi jest jawna. Przyciski przepływu i Alt+Góra/Dół utrzymują krok w jego bieżącej gałęzi. Przeciąganie pozwala przenieść wiadomość, notatkę lub całą grupę do gałęzi nazwanej w podglądzie; opcja Przenieś krok do oferuje ten sam wybór w Szczegółach. Nieprawidłowe miejsca docelowe są wyłączone z podaniem przyczyny, w tym przenoszenie grupy do niej samej, przekroczenie czterech poziomów zagnieżdżenia lub umieszczenie tworzenia/usuwania wewnątrz gałęzi.
Zmiana grupy wielogałęziowej na Opcjonalną lub Pętlę wymaga potwierdzenia przed zachowaniem tylko jej pierwszej gałęzi. Usunięcie gałęzi wymaga potwierdzenia przed usunięciem jej kroków; jeśli pozostanie jedna gałąź, grupa staje się Opcjonalna, a usunięcie jedynej gałęzi usuwa grupę. Usunięcie grupy usuwa wszystkie jej kroki po potwierdzeniu. Cofnij przywraca całą zmianę. Pionowe rozmieszczenie równoległych gałęzi nie sugeruje kolejności ich wykonywania.
Notatki, numeracja i aktywacje
Dodaj notatkę i wybierz uczestników, których powinna obejmować. Notatki zawijają się w swojej ramce i poruszają się wraz z kolejnością sekwencji. Używaj ich do ograniczeń lub wyjaśnień, zamiast umieszczać akapit na strzałce komunikatu.
Widok kontroluje numery komunikatów i automatyczne paski aktywacji. Te opcje wyglądu są zapisywane i uwzględniane w eksporcie obrazu. Numery zapewniają kolejność czytania; nie są to zmierzone znaczniki czasu ani całkowita kolejność wykonywania w równoległych gałęziach.
Paski aktywacji są wnioskowane z wywołań synchronicznych i narysowanych odpowiedzi. Wywołania do samego siebie mogą być zagnieżdżone. Alternatywne gałęzie są obliczane oddzielnie, więc odpowiedzi w jednej gałęzi nie zamykają wywołań w innej. Brakujące odpowiedzi pozostawiają aktywację otwartą do końca tego zakresu; jest to pomoc wizualna, a nie analiza wykonania.
Nowe diagramy rozpoczynają się w czytelnej skali; szerokie diagramy można przewijać w poziomie. Dopasowanie szerokości diagramu zapewnia przegląd przy zachowaniu pionowego odczytu. Przewijaj, aby przeglądać, użyj kontrolek powiększenia lub Ctrl/Command + przewijanie, aby powiększać wokół wskaźnika. Opcja Szukaj przeszukuje nazwy i typy uczestników, wiadomości oraz ich punkty końcowe, notatki, opisy grup i warunki. Dopasowane kroki zachowują odpowiedni kontekst gałęzi; identyfikatory i pozycje są wykluczone. Wyszczyszczenie lub naciśnięcie klawisza Escape przywraca pełny Przepływ, a pusty wynik wyjaśnia, co spróbować. Wybranie wyniku Przepływu lub Sprawdzeń albo dodanie elementu sprawia, że jego etykieta staje się widoczna bez zmiany powiększenia. Na telefonach dzieje się to po powrocie do Diagramu. Przewijanie obszaru roboczego, powiększanie i zaznaczanie to widoki obszaru roboczego znajdujące się poza dokumentem i historią cofania.
Zapisz, udostępnij i importuj
Nowe diagramy pozostają w pamięci. Zapisz loguje w razie potrzeby i tworzy niezależny plik chmurowy diagramu sekwencji. Plik → Otwórz diagramy sekwencji otwiera własną listę plików. Zapisz najnowsze zmiany przed udostępnieniem publicznego linku tylko do odczytu. Publiczni widzowie mogą przeglądać i Eksportuj, ale nie mogą edytować pliku.
Plik → Pobierz JSON zachowuje kompletny edytowalny dokument, w tym pozycje uczestników i odstępy między krokami. Zapisy w chmurze i eksporty obrazów również zachowują to rozmieszczenie. Import JSON akceptuje wyeksportowane pliki Erd Go diagram sekwencji wersja 1 do 4 MB, waliduje cały plik przed zastąpieniem i obsługuje funkcję Cofnij. Starsze pliki zachowują automatyczne odstępy; nakładające się zaimportowane pozycje są wyświetlane bezpiecznie. SQL, Diagram klas, Mermaid i PlantUML nie są formatami importu.
Plik → Nowy diagram ponownie otwiera wybór Pusty/Szablon. Pusty i przykład zapytania API zastępują istniejący model po potwierdzeniu i obsługują funkcję Cofnij. Niezapisane diagramy wyświetlają monit przed opuszczeniem lub przeładowaniem strony. Nic nie jest zapisywane w pamięci przeglądarki.
Eksportuj diagram lub źródło tekstowe
Eksport tworzy pliki PNG, JPEG, WebP, samodzielny wektorowy SVG lub PDF z obrazem. Wybierz Cały diagram lub Bieżący widok (na telefonach najpierw otwórz panel Diagramu) oraz szerokość HD, 2K lub 4K. Wymiary rastrowe są ograniczone do 8192 pikseli na bok i 16 megapikseli; bardzo wysokie diagramy mogą zostać pomniejszone. Użyj SVG dla skalowalnych dużych diagramów lub Bieżącego widoku dla czytelnej sekcji.
Plik → Eksportuj PlantUML / Mermaid wyświetla podgląd, kopiuje i pobiera lokalny tekst. Renderer tekstu kontroluje własny układ i wygląd; symbole uczestników lub kolory mogą się różnić. JSON jest kompletnym formatem edytowalnym. Żadne źródło nie jest wysyłane do zewnętrznego serwera renderującego.
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
endSkróty i limity
| Akcja lub limit | Zachowanie |
|---|---|
| Ctrl/Cmd+S | Zapisz w chmurze; zaloguj się po wyświetleniu monitu. |
| Ctrl/Cmd+K | Otwórz i ustaw fokus na Znajdź w panelu Flow. |
| Ctrl/Cmd+Z / Shift+Z / Ctrl+Y | Cofnij / Ponów poza polami tekstowymi. Pola tekstowe zachowują natywne skróty edycji. |
| Enter / Spacja | Otwórz Szczegóły dla wybranego elementu diagramu. |
| Alt+Lewo / Prawo | Przesuń wybranego uczestnika w lewo lub w prawo. |
| Alt+Góra / Dół | Przesuń wybrany krok w obrębie jego bieżącej gałęzi. |
| Usuń / Backspace | Usuń zaznaczenie poza polami tekstowymi lub użyj przycisku kosza na obszarze roboczym. Kaskadowe usuwanie uczestników oraz usuwanie grup/gałęzi wymaga potwierdzenia. |
| Escape podczas przeciągania | Anuluj podgląd bez zmiany modelu. |
| Uporządkuj | Przywróć automatyczne odstępy bez zmiany kolejności lub gałęzi; Cofnij przywraca rozmieszczenie. |
| Uczestnicy i kroki | 30 uczestników i łącznie 300 kroków, w tym fragmenty i notatki. |
| Tekst | 80 znaków na nazwę uczestnika, 240 na etykietę wiadomości/warunku/grupy, 2000 na notatkę. |
| Pliki i historia | Zaimportowany plik JSON o rozmiarze 4 MB, nazwa pliku w chmurze od 3 do 255 znaków oraz 80 stanów cofania. |
Przejrzyj i rozwiąż problemy
Kontrole oznaczają puste nazwy, duplikaty nazw uczestników, brakujące etykiety komunikatów, puste gałęzie, brakujące warunki oraz niespójną kolejność tworzenia lub niszczenia. Wybierz znalezisko, aby wyświetlić jego Szczegóły. Te kontrole nie wykonują konwersacji ani nie dowodzą zachowania API.
Jeśli import się nie powiedzie, Twój obecny diagram pozostanie nienaruszony. Starszy oczekujący odczyt pliku nie może zastąpić nowszego dokumentu, nowszego importu ani edytowanego modelu. Jeśli zapisywanie w chmurze nie powiedzie się, pozostaw diagram otwarty i pobierz JSON przed wyjściem.
Używaj specyfikacji OMG UML dla znaczenia notacji interakcji. PlantUML i Mermaid mają własną składnię tekstową; wygenerowane pliki są eksportami dla tych narzędzi, a nie językiem importu Erd Go.