ข้ามไปยังเนื้อหาหลัก
ทำ Technical Documentation สำหรับวงจร Request/Response ของ API

API Request Flow

แผนผังคำขอ API ตั้งแต่ Gateway ตรวจรูปแบบและสิทธิ์ ผ่าน Business Logic กับฐานข้อมูล จนสร้าง Response พร้อมเส้นทางปฏิเสธที่สื่อสารได้

สร้างสำเนาใหม่ งานต้นฉบับของเทมเพลตไม่ถูกแก้ไข

ภาพรวม API Request Flow 9 Node
  1. เริ่มต้น

    Client ส่ง Request

    ระบุ Method, Path, Header และ Payload ตามสัญญา

  2. ขั้นตอน

    Gateway ตรวจขนาดและรูปแบบ

    ปฏิเสธคำขอที่ผิดรูปแบบก่อนเข้าระบบหลัก

  3. ตัดสินใจ

    ยืนยันตัวตนและสิทธิ์ผ่านหรือไม่

    ตรวจ Credential และ Scope ฝั่ง Server

  4. ขั้นตอน

    ประมวลผล Business Rule

    ตรวจ Input ซ้ำในขอบเขต Domain

  5. สิ้นสุด

    ตอบกลับ 401 หรือ 403

    ไม่เปิดเผยรายละเอียดสิทธิ์เกินจำเป็น

  6. ขั้นตอน

    อ่านหรือเขียนข้อมูลผ่าน Repository

    ควบคุม Transaction และ Timeout

  7. ตัดสินใจ

    ประมวลผลสำเร็จหรือไม่

    แยกข้อผิดพลาดที่คาดได้จากความล้มเหลวภายใน

และอีก 2 Node ในเทมเพลต

สิ่งที่อยู่ใน Flow

ลำดับหลักของเทมเพลต

รายการนี้เป็นสรุปอ่านเร็ว ส่วนรายละเอียดและทางแยกครบอยู่ใน Graph ที่เปิดแก้ได้

  1. ขั้นที่ 1

    รับ Request ตาม API contract

  2. ขั้นที่ 2

    ตรวจขนาด รูปแบบ ตัวตน และสิทธิ์

  3. ขั้นที่ 3

    ประมวลผลผ่าน Domain กับ Repository

  4. ขั้นที่ 4

    ตอบสถานะสำเร็จหรือข้อผิดพลาดที่ปลอดภัย

เทมเพลตที่เกี่ยวข้อง

พร้อมปรับ Flow ให้ตรงกับทีมแล้วหรือยัง

เปิดสำเนาใน Editor แล้วแก้ Node, Edge และรายละเอียดได้ทันที

ใช้เทมเพลต