ข้ามไปยังเอกสาร

ติดตามการสนทนา

คู่มือ แผนภาพลำดับ

สร้างลำดับการโต้ตอบระหว่าง API และบริการด้วยผู้เข้าร่วม การเรียก การตอบกลับ ทางเลือก และโน้ต

ผู้เข้าร่วมและข้อความ → แผนภาพลำดับเปิดแผนภาพลำดับ

ติดตามการสนทนา

แผนภาพลำดับ (Sequence Diagram) เป็นพื้นที่ทำงานภาพอิสระสำหรับการโต้ตอบระหว่างบุคคล บริการ และระบบ ผู้เข้าร่วมจะเรียงจากซ้ายไปขวา เวลาจะดำเนินลงมาด้านล่างของหน้า โครงร่าง Flow และแผนภาพแสดงแบบจำลองลำดับเดียวกัน

เลือกเทมเพลตคำขอ API เพื่อสำรวจไคลเอ็นต์, Orders API, บริการ Auth และฐานข้อมูล เทมเพลตจะตรวจสอบโทเค็นและใช้กลุ่ม if/else เพื่อส่งคืนคำสั่งซื้อหรือการตอบกลับว่าไม่ได้รับอนุญาต เลือก แผนภาพเปล่า เพื่อสร้างบทสนทนาของคุณเอง

สร้างการโต้ตอบ API

  1. เพิ่มผู้เข้าร่วมสำหรับ Client และ API เลือกหนึ่งรายการในแผง Flow หรือบนแผนภาพเพื่อแก้ไขชื่อ สัญลักษณ์ สี และลำดับจากซ้ายไปขวา
  2. ผืนผ้าใบเปล่าจะแนะนำคุณผ่านผู้เข้าร่วมและข้อความแรกของคุณ ชื่อใหม่และข้อความในข้อความจะถูกเลือกไว้เพื่อให้คุณพิมพ์ได้ทันที เลือกข้อความ จากนั้นแก้ไข จาก, ถึง และ ข้อความ ในรายละเอียด แถบเพิ่มจะแสดงตำแหน่งที่ขั้นตอนใหม่จะไปและใครเป็นผู้ส่งข้อความ ข้อความจะถูกเพิ่มหลังจากขั้นตอนที่เลือก ในสาขาเดียวกัน การเลือกผู้เข้าร่วมจะเป็นการเริ่มข้อความถัดไปจากผู้เข้าร่วมนั้น ข้อความที่เลือกจะระบุจุดสิ้นสุดของข้อความนั้น โน้ตที่เพิ่มจากผู้เข้าร่วมที่เลือกจะใช้จุดยึดนั้น หากไม่มีขั้นตอนที่เลือกไว้ โน้ตจะถูกเพิ่มไปยังโฟลว์หลัก
  3. เลือกข้อความและใช้ Add reply after this message เพื่อย้อนกลับจุดสิ้นสุดและเพิ่มการส่งคืนแบบเส้นประ ลากขั้นตอนเพื่อวางตามเวลา ตัวอย่างจะแสดงปลายทางของขั้นตอนเหล่านั้น การควบคุมขึ้น/ลงของ Flow จะจัดลำดับใหม่ภายในสาขาปัจจุบัน
  4. ใช้กลุ่ม → If / else, Optional, Loop หรือ Parallel เลือกสาขาเพื่อแก้ไขเงื่อนไขหรือเพิ่มขั้นตอนที่นั่น การเพิ่มสาขาจะแทรกก่อนการสำรองข้อมูล else ใน Flow แต่ละสาขาจะมีปุ่ม + ของตัวเอง
  5. เรียกใช้การตรวจสอบ ตรวจสอบแผนภาพ และ บันทึก หรือ ส่งออก ผลลัพธ์ บนโทรศัพท์ ให้ใช้แท็บ Flow, Diagram และ Details; แก้ไขรายละเอียด จะเปิดองค์ประกอบที่เลือกและ กลับไปที่แผนภาพ จะกลับไปยังผืนผ้าใบ

เลือก ย้าย และเพิ่มบนแผนภาพ

คลิกที่ส่วนหัวของผู้เข้าร่วมหรือเส้นชีวิต ข้อความ บันทึก ขอบกลุ่ม หรือพื้นที่สาขาเพื่อเลือก กด Enter หรือ Space เพื่อเปิดรายละเอียด ลากส่วนหัวของผู้เข้าร่วมไปทางซ้ายหรือขวาเพื่อปรับระยะห่างและลำดับ ลากข้อความ บันทึก หรือทั้งกลุ่มในแนวตั้งเพื่อกำหนดลำดับเวลาและเว้นช่องว่าง สำหรับหน้าจอสัมผัส ให้ลากที่จุดจับที่มองเห็นได้ ปัดในบริเวณอื่นเพื่อเลื่อน

การแสดงตัวอย่างจะแสดงแผนภาพที่เสนอและระบุสาขาปลายทาง วางลงในสาขาอื่นเพื่อย้ายขั้นตอน หรือใช้ ย้ายขั้นตอนไปที่ ในรายละเอียด การสร้างและการทำลายจะคงอยู่ในขั้นตอนหลัก กลุ่มไม่สามารถย้ายเข้าไปอยู่ในตัวเองได้ การลากจะยึดที่ 8 พิกเซล การกด Escape หรือยกเลิกจะทำให้โมเดลไม่เปลี่ยนแปลง การปล่อยจะทำให้เกิดการเปลี่ยนแปลงที่สามารถเลิกทำได้ การจัดระเบียบจะคืนค่าระยะห่างอัตโนมัติในขณะที่ยังคงลำดับและสาขาของคุณไว้

คลิกที่แถบ Add หรือลาก Participant, Message, Note หรือ Group ลงบนแผนภาพบนเดสก์ท็อป ตัวเลือกกลุ่มจะอธิบาย If / else, Optional, Loop และ Parallel ด้วยภาษาที่เข้าใจง่าย ตัวอย่างการวางและส่วนท้ายของผืนผ้าใบจะระบุชื่อสาขาปลายทางและแสดงตำแหน่งในเวลา การลากจากจานสีจะเริ่มต้นด้วยผู้เข้าร่วมสองคนแรก ทิศทางจะแสดงระหว่างการลาก เลือกจุดสิ้นสุดของข้อความในรายละเอียด การวางใกล้กับเส้นชีวิตจะไม่เปลี่ยนจุดสิ้นสุดเหล่านั้น

คลิกที่พื้นที่ว่างบนผืนผ้าใบเพื่อล้างการเลือก ลากพื้นที่ว่างบนผืนผ้าใบหรือใช้ปุ่มกลางของเมาส์เพื่อสำรวจในขณะที่ยังคงการเลือกไว้ สามารถเพิ่มกลุ่มก่อนผู้เข้าร่วมได้ ตัวยึดตำแหน่งบนผืนผ้าใบและปุ่ม Flow + จะเพิ่มผู้เข้าร่วมคนแรก จากนั้นจะเสนอข้อความแรก

ผู้เข้าร่วมและเส้นชีวิต

Participant, Actor, Boundary, Control, Entity และ Database จะเปลี่ยนสัญลักษณ์ส่วนหัว สิ่งเหล่านี้เป็นบทบาทในการโต้ตอบ ไม่ใช่ตารางฐานข้อมูล ชื่อและสีเน้นฐานสิบหกแบบทึบ (ไม่บังคับ) จะถูกบันทึกพร้อมกับแผนภาพ

ลากส่วนหัวของผู้เข้าร่วมเพื่อจัดตำแหน่ง ส่วนหัวที่อยู่ใกล้เคียงจะขยับออกเพื่อให้ยังคงอ่านได้ง่าย การย้ายไปทางซ้ายและย้ายไปทางขวาจะเป็นการสลับตำแหน่งในลำดับที่แสดง จุดสิ้นสุดของข้อความจะยังคงไม่เปลี่ยนแปลง รายละเอียดผู้เข้าร่วมมีตัวเลือกการดำเนินการส่งข้อความและเพิ่มบันทึก ข้อความที่ส่งถึงผู้เข้าร่วมคนเดียวกันจะกลายเป็น self-call โดยอัตโนมัติ; แผนภาพที่มีผู้เข้าร่วมคนเดียวจะแสดงตัวเลือกนี้อย่างชัดเจน การลบผู้เข้าร่วมจะลบข้อความที่เกี่ยวข้องและลบจุดยึดออกจากบันทึกด้วย; การ Undo จะกู้คืนการเปลี่ยนแปลงทั้งหมด

การเรียก การตอบกลับ และช่วงเวลาชีวิต

การเรียก การตอบกลับ และช่วงเวลาชีวิต
ชนิดความหมาย
การเรียกแบบซิงโครนัสเส้นทึบและลูกศรทึบ ผู้ส่งรอการดำเนินการที่ถูกเรียก
ข้อความแบบอะซิงโครนัสเส้นทึบและลูกศรโปร่ง ผู้ส่งอาจดำเนินการต่อโดยไม่ต้องรอ
ตอบกลับ / ส่งคืนเส้นประที่กลับไปยังผู้เรียก เพิ่มการตอบกลับเพื่อย้อนกลับจุดสิ้นสุดของข้อความที่เลือก
สร้างผู้เข้าร่วมการสร้างจะอยู่ที่การโต้ตอบแรกของเส้นอายุการใช้งานเป้าหมาย ส่วนหัวจะเริ่มต้นที่ข้อความนี้
ทำลายผู้เข้าร่วม (Destroy participant)เครื่องหมาย X แสดงถึงการทำลายเป้าหมาย นี่ควรเป็นการโต้ตอบครั้งสุดท้ายของมัน
รองรับการสร้างและการทำลายในขั้นตอนหลัก นอกเหนือจากส่วนย่อย การตรวจสอบจะแจ้งเตือนลำดับอายุการใช้งานที่ไม่สอดคล้องกัน การจัดลำดับที่ไม่ถูกต้องจะทำให้เส้นอายุการใช้งานทั้งหมดมองเห็นได้ เพื่อไม่ให้การโต้ตอบในภายหลังถูกซ่อนไว้

จัดกลุ่มสาขาโดยไม่สูญเสียความหมาย

If / else (alt) ประกอบด้วย 2–6 สาขาทางเลือก; จะเลือกโอเปอแรนด์ที่ตรงกันเพียงหนึ่งรายการ Optional (opt) ประกอบด้วยหนึ่งสาขาเงื่อนไข Loop ประกอบด้วยหนึ่งสาขาที่ทำซ้ำ; เขียนเงื่อนไขการวนซ้ำ Parallel (par) ประกอบด้วย 2–6 โอเปอแรนด์ที่การโต้ตอบอาจสลับกันได้

การเป็นสมาชิกสาขามีความชัดเจน ปุ่ม Flow และ Alt+Up/Down จะคงขั้นตอนไว้ในสาขาปัจจุบัน การลากสามารถโอนข้อความ บันทึก หรือทั้งกลุ่มไปยังสาขาที่ระบุในตัวอย่างได้ Move step to ให้ตัวเลือกเดียวกันในรายละเอียด ปลายทางที่ไม่ถูกต้องจะถูกปิดใช้งานพร้อมเหตุผล รวมถึงการย้ายกลุ่มเข้าไปในตัวเอง การเกินสี่ระดับที่ซ้อนกัน หรือการใส่การสร้าง/ทำลายภายในสาขา

การเปลี่ยนกลุ่มแบบหลายสาขา (multi-branch group) ให้เป็น Optional หรือ Loop จะมีการถามก่อนที่จะเก็บไว้เพียงสาขาแรก การลบสาขาจะมีการถามก่อนที่จะลบขั้นตอนของสาขานั้น หากเหลือเพียงสาขาเดียว กลุ่มจะกลายเป็น Optional และการลบสาขาเดียวที่เหลืออยู่จะเป็นการลบกลุ่มนั้น การลบกลุ่มจะเป็นการลบขั้นตอนทั้งหมดภายในกลุ่มโดยมีการยืนยัน การเลิกทำ (Undo) จะกู้คืนการเปลี่ยนแปลงทั้งหมด การวางสาขาแบบขนานในแนวตั้งไม่ได้บ่งบอกถึงลำดับการทำงานระหว่างสาขาเหล่านั้น

บันทึกย่อ การกำหนดหมายเลข และการเปิดใช้งาน

เพิ่มบันทึกและเลือกผู้เข้าร่วมที่ต้องการให้ครอบคลุม บันทึกจะตัดคำภายในกรอบและเคลื่อนที่ไปพร้อมกับลำดับของลำดับ ใช้บันทึกสำหรับข้อจำกัดหรือคำอธิบายแทนการใส่ย่อหน้าบนลูกศรข้อความ

ตัวควบคุมมุมมองจะจัดการหมายเลขข้อความและแถบการเปิดใช้งานอัตโนมัติ ตัวเลือกการแสดงผลเหล่านี้จะถูกบันทึกและรวมอยู่ในการส่งออกรูปภาพ ตัวเลขให้ลำดับการอ่าน ไม่ใช่การวัดเวลาหรือลำดับการดำเนินการรวมข้ามสาขาคู่ขนาน

แถบการทำงาน (Activation bars) จะถูกอนุมานจากการเรียกแบบซิงโครนัสและการตอบกลับที่วาดไว้ การเรียกตัวเองสามารถซ้อนกันได้ สาขาทางเลือกจะถูกคำนวณแยกกัน ดังนั้นการตอบกลับในสาขาหนึ่งจะไม่ปิดการเรียกในอีกสาขาหนึ่ง การตอบกลับที่ขาดหายไปจะทำให้แถบการทำงานเปิดค้างไว้จนถึงจุดสิ้นสุดของขอบเขตนั้น นี่เป็นตัวช่วยทางภาพมากกว่าการวิเคราะห์การทำงาน

แผนภาพใหม่จะเริ่มต้นที่ขนาดที่อ่านได้ แผนภาพที่มีความกว้างมากสามารถเลื่อนในแนวนอนได้ การปรับความกว้างของแผนภาพจะช่วยให้เห็นภาพรวมในขณะที่ยังคงการอ่านในแนวตั้งไว้ เลื่อนเพื่อสำรวจ ใช้ตัวควบคุมการซูม หรือกด Ctrl/Command พร้อมกับการเลื่อนเพื่อซูมรอบตัวชี้ การค้นหาจะค้นหาชื่อและประเภทของผู้เข้าร่วม ข้อความและจุดสิ้นสุดของข้อความ บันทึกย่อ คำอธิบายกลุ่ม และเงื่อนไข ขั้นตอนที่ตรงกันจะคงบริบทของสาขาที่เกี่ยวข้องไว้ โดยไม่รวม ID และตำแหน่ง การล้างหรือกด Escape จะคืนค่า Flow เต็มรูปแบบ และผลลัพธ์ที่ว่างเปล่าจะอธิบายสิ่งที่ควรลองทำ การเลือกผลลัพธ์ Flow หรือ Checks หรือการเพิ่มองค์ประกอบ จะนำป้ายกำกับขององค์ประกอบนั้นมาแสดงโดยไม่เปลี่ยนการซูม บนโทรศัพท์สิ่งนี้จะเกิดขึ้นเมื่อคุณกลับไปที่แผนภาพ การเลื่อนผืนผ้าใบ การซูม และการเลือกเป็นมุมมองพื้นที่ทำงานที่อยู่นอกเอกสารและประวัติการเลิกทำ

บันทึก, แชร์ และนำเข้า

แผนภาพใหม่จะยังคงอยู่ในหน่วยความจำ ระบบจะลงชื่อเข้าใช้เมื่อจำเป็นและสร้างไฟล์คลาวด์แผนภาพลำดับอิสระ ไฟล์ → เปิดแผนภาพลำดับจะเปิดรายการไฟล์ของตัวเอง บันทึกการเปลี่ยนแปลงล่าสุดก่อนแชร์ลิงก์สาธารณะแบบอ่านอย่างเดียว ผู้ชมสาธารณะสามารถตรวจสอบและส่งออกได้ แต่ไม่สามารถแก้ไขไฟล์ได้

ไฟล์ → ดาวน์โหลด JSON จะเก็บเอกสารที่แก้ไขได้ทั้งหมด รวมถึงตำแหน่งของผู้เข้าร่วมและช่องว่างระหว่างขั้นตอน การบันทึกบนคลาวด์และการส่งออกรูปภาพจะคงตำแหน่งเหล่านี้ไว้เช่นกัน การนำเข้า JSON รองรับไฟล์แผนภาพลำดับ Erd Go เวอร์ชัน 1 ที่ส่งออกไปแล้วขนาดสูงสุด 4 MB โดยจะตรวจสอบไฟล์ทั้งหมดก่อนการแทนที่ และรองรับการเลิกทำ (Undo) ไฟล์รุ่นเก่าจะยังคงการเว้นระยะห่างอัตโนมัติ ตำแหน่งที่นำเข้าแล้วซ้อนทับกันจะถูกแสดงอย่างปลอดภัย SQL, แผนภาพคลาส, Mermaid และ PlantUML ไม่ใช่รูปแบบสำหรับการนำเข้า

ไฟล์ → แผนภาพใหม่ จะเปิดตัวเลือกว่าง/เทมเพลตอีกครั้ง แผนภาพว่างและตัวอย่างคำขอ API จะแทนที่โมเดลที่มีอยู่โดยมีการยืนยันและการเลิกทำ แผนภาพที่ไม่ได้บันทึกจะแจ้งเตือนก่อนออกจากหรือโหลดซ้ำ ไม่มีการเขียนข้อมูลใดๆ ลงในที่เก็บข้อมูลของเบราว์เซอร์

ส่งออกแผนภาพหรือแหล่งข้อมูลที่เป็นข้อความ

การส่งออกจะสร้างไฟล์ PNG, JPEG, WebP, เวกเตอร์ SVG แบบสแตนด์อโลน หรือ PDF ที่มีรูปภาพประกอบ เลือกแผนภาพทั้งหมดหรือมุมมองปัจจุบัน (เปิดแผงแผนภาพก่อนบนโทรศัพท์) และความกว้างแบบ HD, 2K หรือ 4K ขนาดของแรสเตอร์จำกัดอยู่ที่ 8192 พิกเซลต่อด้านและ 16 เมกะพิกเซล แผนภาพที่สูงมากอาจถูกลดขนาดลง ใช้ SVG สำหรับแผนภาพขนาดใหญ่ที่ปรับขนาดได้ หรือมุมมองปัจจุบันสำหรับส่วนที่อ่านได้

ไฟล์ → ส่งออก PlantUML / Mermaid จะแสดงตัวอย่าง คัดลอก และดาวน์โหลดข้อความในเครื่อง ตัวแสดงผลข้อความจะควบคุมเค้าโครงและลักษณะที่ปรากฏของตัวเอง สัญลักษณ์หรือสีของผู้เข้าร่วมอาจแตกต่างกัน JSON เป็นรูปแบบที่แก้ไขได้สมบูรณ์ ไม่มีการส่งแหล่งข้อมูลไปยังเซิร์ฟเวอร์การแสดงผลของบุคคลที่สาม

Mermaid / ตัวอย่างข้อความลำดับการร้องขอ 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
สร้างโฟลว์นี้ด้วยภาพหรือใช้เทมเพลตคำขอ API ตัวอย่างแสดงการส่งออกข้อความ ซึ่งไม่สามารถนำเข้าสู่ Erd Go ได้

ทางลัดและขีดจำกัด

ทางลัดและขีดจำกัด
การดำเนินการหรือขีดจำกัดพฤติกรรม
Ctrl/Cmd+Sบันทึกลงคลาวด์; ลงชื่อเข้าใช้เมื่อได้รับแจ้ง
Ctrl/Cmd+Kเปิดและโฟกัสที่ ค้นหา ในพาเนล Flow
Ctrl/Cmd+Z / Shift+Z / Ctrl+Yเลิกทำ / ทำซ้ำ นอกช่องข้อความ ช่องข้อความยังคงใช้ทางลัดการแก้ไขแบบเนทีฟ
Enter / Spaceเปิดรายละเอียดสำหรับองค์ประกอบแผนภาพที่โฟกัสอยู่
Alt+ซ้าย / ขวาย้ายผู้เข้าร่วมที่เลือกไปทางซ้ายหรือขวา
Alt+ขึ้น / ลงย้ายขั้นตอนที่เลือกภายในสาขาปัจจุบัน
ลบ / Backspaceลบสิ่งที่เลือกไว้นอกช่องข้อความ หรือใช้ปุ่มถังขยะบนผืนผ้าใบ การลบผู้เข้าร่วมแบบต่อเนื่องและการลบกลุ่ม/สาขาจะมีการถามเพื่อยืนยัน
กด Escape ระหว่างการลากยกเลิกการแสดงตัวอย่างโดยไม่เปลี่ยนแบบจำลอง
จัดระเบียบคืนค่าระยะห่างอัตโนมัติโดยไม่เปลี่ยนลำดับหรือสาขา การเลิกทำ (Undo) จะคืนค่าตำแหน่งเดิม
ผู้เข้าร่วมและขั้นตอนผู้เข้าร่วม 30 คน และรวม 300 ขั้นตอน รวมถึงส่วนย่อยและบันทึกย่อ
ข้อความ80 ตัวอักษรต่อชื่อผู้เข้าร่วม, 240 ต่อข้อความ/เงื่อนไข/ป้ายกำกับกลุ่ม, 2,000 ต่อบันทึกย่อ
ไฟล์และประวัติJSON ที่นำเข้าขนาด 4 MB, ชื่อไฟล์บนคลาวด์ความยาว 3–255 อักขระ และสถานะเลิกทำ 80 รายการ

ตรวจสอบและแก้ไขปัญหา

การตรวจสอบจะแจ้งเตือนชื่อที่ว่างเปล่า, ชื่อผู้เข้าร่วมที่ซ้ำกัน, ป้ายกำกับข้อความที่ขาดหายไป, สาขาที่ว่างเปล่า, เงื่อนไขที่ขาดหายไป และลำดับการสร้างหรือทำลายที่ไม่สอดคล้องกัน เลือกผลลัพธ์เพื่อดูรายละเอียด การตรวจสอบเหล่านี้ไม่ได้ดำเนินการสนทนาหรือพิสูจน์พฤติกรรมของ API

หากการนำเข้าล้มเหลว แผนภาพปัจจุบันของคุณจะยังคงอยู่ครบถ้วน การอ่านไฟล์ที่ค้างอยู่เก่าไม่สามารถแทนที่เอกสารใหม่ การนำเข้าใหม่ หรือแบบจำลองที่แก้ไขแล้วได้ หากการบันทึกบนคลาวด์ล้มเหลว ให้เปิดแผนภาพค้างไว้และดาวน์โหลด JSON ก่อนออกจากหน้าเว็บ

ใช้ข้อกำหนด OMG UML สำหรับความหมายของสัญลักษณ์การโต้ตอบ PlantUML และ Mermaid มีไวยากรณ์ข้อความของตนเอง ไฟล์ที่สร้างขึ้นคือการส่งออกสำหรับเครื่องมือเหล่านั้น ไม่ใช่ภาษาสำหรับการนำเข้า Erd Go