Lewati ke dokumentasi

IKUTI PERCAKAPAN

Panduan Diagram sekuens

Buat interaksi API dan layanan yang berurutan dengan peserta, panggilan, balasan, cabang, dan catatan.

Peserta & pesan → Diagram sekuensBuka Diagram Sekuens

Ikuti percakapan

Diagram Urutan adalah ruang kerja visual independen untuk interaksi antara orang, layanan, dan sistem. Peserta berjalan dari kiri ke kanan; waktu berjalan ke bawah halaman. Garis besar Alur dan diagram menunjukkan model terurut yang sama.

Pilih templat permintaan API untuk menjelajahi klien, API Pesanan, layanan Auth, dan database. Templat memverifikasi token dan menggunakan grup jika/lain untuk mengembalikan pesanan atau respons tidak sah. Pilih diagram Kosong untuk membangun percakapan Anda sendiri.

Bangun interaksi API

  1. Tambahkan peserta untuk Klien dan API. Pilih salah satu di panel Alur atau pada diagram untuk mengedit nama, simbol, warna, dan urutan dari kiri ke kanan.
  2. Kanvas kosong memandu Anda melalui partisipan dan pesan pertama Anda. Nama baru dan teks pesan dipilih agar Anda dapat langsung mengetik. Pilih Pesan, lalu edit Dari, Kepada, dan Pesan di Detail. Bilah Tambah menunjukkan ke mana langkah baru akan ditempatkan dan siapa yang mengirim pesan. Pesan ditambahkan setelah langkah yang dipilih, di cabang yang sama. Memilih partisipan memulai pesan berikutnya dari partisipan tersebut; pesan yang dipilih menyediakan titik akhirnya. Catatan yang ditambahkan dari partisipan yang dipilih menggunakan jangkar tersebut. Tanpa langkah yang dipilih, pesan ditambahkan ke alur utama.
  3. Pilih pesan dan gunakan Tambahkan balasan setelah pesan ini untuk membalik titik akhirnya dan menambahkan pengembalian putus-putus. Seret langkah untuk menempatkannya sesuai waktu; pratinjau menunjukkan tujuannya. Kontrol atas/bawah Alur menyusun ulang dalam cabang saat ini.
  4. Gunakan Grup → If / else, Opsional, Perulangan, atau Paralel. Pilih cabang untuk mengedit kondisinya atau tambahkan langkah di sana. Tambah cabang menyisipkan sebelum cadangan else. Di Alur, setiap cabang memiliki tombol + sendiri.
  5. Jalankan Pemeriksaan, tinjau diagram, lalu Simpan atau Ekspor hasilnya. Di ponsel, gunakan tab Alur, Diagram, dan Detail; Edit detail membuka elemen yang dipilih dan Kembali ke diagram kembali ke kanvas.

Pilih, pindahkan, dan tambahkan pada diagram

Klik header partisipan atau lifeline, pesan, catatan, batas grup, atau area cabang untuk memilihnya. Tekan Enter atau Spasi untuk membuka Detail. Seret header partisipan ke kiri atau ke kanan untuk menyesuaikan spasi dan urutan; seret pesan, catatan, atau seluruh grup secara vertikal untuk mengatur urutan waktu dan menyisakan celah. Di layar sentuh, seret pegangan yang terlihat; gesek di tempat lain untuk menggulir.

Pratinjau menampilkan diagram yang diusulkan dan menamai cabang tujuannya. Lepaskan ke cabang lain untuk mentransfer langkah, atau gunakan Pindahkan langkah ke di Detail. Pembuatan dan penghancuran tetap berada di alur utama; grup tidak dapat berpindah ke dalam dirinya sendiri. Seretan akan menempel pada 8 piksel. Keluar atau membatalkan akan membiarkan model tidak berubah; melepaskan akan membuat satu perubahan yang dapat dibatalkan. Rapikan memulihkan spasi otomatis sambil tetap menjaga urutan dan cabang Anda.

Klik bilah Tambah, atau di desktop seret Partisipan, Pesan, Catatan, atau Grup ke diagram. Pilihan grup menjelaskan Jika / else, Opsional, Perulangan, dan Paralel dalam bahasa yang mudah dipahami. Pratinjau jatuhkan dan footer kanvas menamai cabang tujuan dan menunjukkan posisinya dalam waktu. Seretan palet dimulai dengan dua partisipan pertama; arah ditunjukkan selama menyeret. Pilih titik akhir pesan di Detail; menjatuhkan di dekat lifeline tidak mengubahnya.

Klik kanvas kosong untuk menghapus pilihan. Seret kanvas kosong atau gunakan tombol tengah mouse untuk menjelajah sambil mempertahankan pilihan. Grup dapat ditambahkan sebelum partisipan; placeholder kanvas dan tombol Alur + akan menambahkan partisipan pertama, lalu menawarkan pesan pertama.

Partisipan dan garis hidup

Partisipan, Aktor, Batas, Kontrol, Entitas, dan Basis Data mengubah simbol header. Mereka adalah peran dalam interaksi, bukan tabel basis data. Nama dan warna aksen heksadesimal buram opsional disimpan bersama diagram.

Seret header partisipan untuk memposisikannya; header di dekatnya bergeser untuk tetap terbaca. Pindah kiri dan Pindah kanan menukar posisinya dalam urutan tampilan. Titik akhir pesan tetap tidak berubah. Detail Partisipan menawarkan tindakan Kirim pesan dan Tambah catatan. Pesan ke partisipan yang sama menjadi panggilan mandiri secara otomatis; diagram satu partisipan menawarkan ini secara eksplisit. Menghapus partisipan juga menghapus pesan yang melibatkannya dan menghapus anchor-nya dari catatan; Undo memulihkan perubahan lengkap.

Panggilan, balasan, dan masa aktif

Panggilan, balasan, dan masa aktif
JenisArti
Panggilan sinkronGaris padat dan panah terisi. Pengirim menunggu operasi yang dipanggil.
Pesan asinkronGaris padat dan panah terbuka. Pengirim dapat melanjutkan tanpa menunggu.
Balas / kembaliGaris putus-putus kembali ke pemanggil. Tambahkan balasan membalikkan titik akhir pesan yang dipilih.
Buat partisipanPembuatan berada pada interaksi pertama garis hidup target. Headernya dimulai pada pesan ini.
Hancurkan partisipanTanda X menandai kehancuran target. Ini seharusnya menjadi interaksi terakhirnya.
Pembuatan dan penghancuran didukung dalam alur utama, di luar fragmen. Bendera pemeriksaan mengurutkan masa hidup yang tidak konsisten; pengurutan yang tidak valid membuat seluruh garis hidup terlihat sehingga interaksi selanjutnya tidak tersembunyi.

Kelompokkan cabang tanpa kehilangan maknanya

If / else (alt) berisi 2–6 cabang alternatif; tepat satu operan yang cocok dipilih. Optional (opt) berisi satu cabang kondisional. Loop berisi satu cabang berulang; tulis kondisi iterasi. Parallel (par) berisi 2–6 operan yang interaksinya dapat saling berselang.

Keanggotaan cabang bersifat eksplisit. Tombol alur dan Alt+Atas/Bawah mempertahankan langkah di cabang saat ini. Menyeret dapat mentransfer pesan, catatan, atau seluruh kelompok ke cabang yang dinamai dalam pratinjau; Pindahkan langkah ke menawarkan pilihan yang sama di Detail. Tujuan yang tidak valid dinonaktifkan dengan alasannya, termasuk memindahkan kelompok ke dalam dirinya sendiri, melebihi empat tingkat bersarang, atau menempatkan pembuatan/penghancuran di dalam cabang.

Mengubah grup multi-cabang menjadi Opsional atau Perulangan akan meminta konfirmasi sebelum hanya mempertahankan cabang pertamanya. Menghapus cabang akan meminta konfirmasi sebelum menghapus langkah-langkahnya; jika satu cabang tersisa, grup menjadi Opsional, dan menghapus satu-satunya cabang akan menghapus grup. Menghapus grup akan menghapus semua langkahnya dengan konfirmasi. Urungkan mengembalikan perubahan secara lengkap. Penempatan vertikal cabang paralel tidak menyiratkan urutan eksekusi di antara mereka.

Catatan, penomoran, dan aktivasi

Tambahkan catatan dan pilih peserta yang harus dicakupnya. Catatan akan terbungkus di dalam bingkai dan bergerak mengikuti urutan sekuens. Gunakan untuk batasan atau penjelasan alih-alih meletakkan satu paragraf pada panah pesan.

Kontrol tampilan nomor pesan dan bilah aktivasi otomatis. Opsi tampilan ini disimpan dan disertakan dalam ekspor gambar. Nomor memberikan urutan baca; nomor tersebut bukanlah stempel waktu yang diukur atau urutan eksekusi total di seluruh cabang paralel.

Bilah aktivasi disimpulkan dari panggilan sinkron dan balasan yang ditarik. Panggilan mandiri dapat bersarang. Cabang alternatif dihitung secara terpisah sehingga balasan di satu cabang tidak menutup panggilan di cabang lain. Balasan yang hilang meninggalkan aktivasi terbuka hingga akhir cakupan tersebut; ini adalah bantuan visual daripada analisis eksekusi.

Diagram baru dimulai pada skala yang dapat dibaca; diagram yang lebar dapat digulir secara horizontal. Sesuaikan lebar diagram memberikan gambaran umum sambil mempertahankan pembacaan vertikal. Gulir untuk menjelajah, gunakan kontrol zoom, atau Ctrl/Command ditambah gulir untuk memperbesar di sekitar penunjuk. Temukan mencari nama dan tipe partisipan, pesan dan titik akhirnya, catatan, deskripsi grup, dan kondisi. Langkah yang cocok mempertahankan konteks cabangnya yang relevan; ID dan posisi dikecualikan. Bersihkan atau Escape memulihkan Alur penuh, dan hasil kosong menjelaskan apa yang harus dicoba. Memilih hasil Alur atau Pemeriksaan, atau menambahkan elemen, akan menampilkan labelnya tanpa mengubah zoom. Di ponsel, ini terjadi saat Anda kembali ke Diagram. Pengguliran kanvas, zoom, dan pemilihan adalah tampilan ruang kerja di luar dokumen dan riwayat Urungkan.

Simpan, bagikan, dan impor

Diagram baru tetap berada di memori. Simpan akan meminta masuk saat diperlukan dan membuat file cloud diagram urutan yang independen. File → Buka diagram urutan akan membuka daftar filenya sendiri. Simpan perubahan terbaru sebelum membagikan tautan publik yang hanya dapat dibaca. Penampil publik dapat memeriksa dan mengekspor tetapi tidak dapat mengedit file tersebut.

File → Unduh JSON menyimpan dokumen lengkap yang dapat diedit, termasuk posisi partisipan dan celah langkah. Simpanan cloud dan ekspor gambar juga mempertahankan penempatan ini. Impor JSON menerima file versi 1 diagram urutan Erd Go yang diekspor hingga 4 MB, memvalidasi seluruh file sebelum penggantian, dan mendukung Urungkan. File yang lebih lama mempertahankan spasi otomatis; posisi impor yang tumpang tindih ditampilkan dengan aman. SQL, Diagram Kelas, Mermaid, dan PlantUML bukanlah format impor.

File → Diagram baru membuka kembali pemilih Kosong/Templat. Kosong dan contoh permintaan API mengganti model yang ada dengan konfirmasi dan Urungkan. Diagram yang belum disimpan akan meminta sebelum keluar atau memuat ulang. Tidak ada yang ditulis ke penyimpanan browser.

Ekspor diagram atau sumber teks

Ekspor membuat PNG, JPEG, WebP, vektor SVG mandiri, atau PDF berbasis gambar. Pilih Seluruh diagram atau Tampilan saat ini (buka panel Diagram terlebih dahulu di ponsel) dan lebar HD, 2K, atau 4K. Dimensi raster dibatasi hingga 8192 piksel per sisi dan 16 megapiksel; diagram yang sangat tinggi mungkin akan diperkecil. Gunakan SVG untuk diagram besar yang dapat disesuaikan skalanya, atau Tampilan saat ini untuk bagian yang mudah dibaca.

File → Ekspor PlantUML / Mermaid mempratinjau, menyalin, dan mengunduh teks lokal. Perender teks mengontrol tata letak dan tampilannya sendiri; simbol atau warna partisipan mungkin berbeda. JSON adalah format lengkap yang dapat diedit. Tidak ada sumber yang dikirim ke server rendering pihak ketiga.

Mermaid / Contoh teks alur permintaan 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
Bangun alur ini secara visual atau gunakan templat permintaan API. Contoh tersebut mengilustrasikan ekspor teks; ini tidak dapat diimpor ke Erd Go.

Pintasan dan batas

Pintasan dan batas
Tindakan atau batasanPerilaku
Ctrl/Cmd+SSimpan ke cloud; masuk saat diminta.
Ctrl/Cmd+KBuka dan fokuskan Temukan di panel Alur.
Ctrl/Cmd+Z / Shift+Z / Ctrl+YUrungkan / Ulangi di luar bidang teks. Bidang teks mempertahankan pintasan pengeditan bawaan.
Enter / SpasiBuka Detail untuk elemen diagram yang difokuskan.
Alt+Kiri / KananPindahkan partisipan yang dipilih ke kiri atau ke kanan.
Alt+Atas / BawahPindahkan langkah yang dipilih di dalam cabangnya saat ini.
Hapus / BackspaceHapus pilihan di luar kolom teks, atau gunakan tombol sampah kanvas. Penghapusan partisipan dan penghapusan grup/cabang akan meminta konfirmasi.
Escape selama penyeretanBatalkan pratinjau tanpa mengubah model.
RapikanPulihkan spasi otomatis tanpa mengubah urutan atau cabang; Urungkan memulihkan penempatan.
Partisipan dan langkah-langkah30 partisipan dan total 300 langkah, termasuk fragmen dan catatan.
Teks80 karakter per nama partisipan, 240 per label pesan/kondisi/grup, 2.000 per catatan.
File dan riwayatJSON yang diimpor sebesar 4 MB, nama file cloud 3–255 karakter, dan 80 status urungkan.

Tinjau dan pecahkan masalah

Pemeriksaan menandai nama yang kosong, nama partisipan yang duplikat, label pesan yang hilang, cabang yang kosong, kondisi yang hilang, dan pengurutan pembuatan atau penghancuran yang tidak konsisten. Pilih temuan untuk menampilkan Detailnya. Pemeriksaan ini tidak mengeksekusi percakapan atau membuktikan perilaku API.

Jika impor gagal, diagram Anda saat ini tetap utuh. Pembacaan file tertunda yang lebih lama tidak dapat menggantikan dokumen yang lebih baru, impor yang lebih baru, atau model yang telah diedit. Jika penyimpanan cloud gagal, biarkan diagram tetap terbuka dan unduh JSON sebelum keluar.

Gunakan spesifikasi OMG UML untuk arti notasi interaksi. PlantUML dan Mermaid memiliki sintaks teks mereka sendiri; file yang dihasilkan adalah ekspor untuk alat tersebut, bukan bahasa impor Erd Go.