ข้ามไปยังเนื้อหา
กลับไปดูบริการทั้งหมด

ระบบหลังบ้าน ฐานข้อมูล และ API

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

คุยเรื่องโครงการ
CONTRACT / ACCESS / DATAEXPLICIT SYSTEM BOUNDARIES

บริการ API แบบจำลองข้อมูล และเอกสารเชื่อมต่อ

สารบัญเนื้อหาในหน้านี้

เริ่มจากจุดที่ระบบต้องการ

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

ตัวอย่างงานที่เหมาะสม

  • API สำหรับเว็บ แอปมือถือ และระบบภายในที่ใช้ข้อมูลร่วมกัน
  • เชื่อมระบบบัญชี คลังสินค้า หรือบริการภายนอกที่มี API ให้ใช้งาน
  • ปรับฐานข้อมูลหรือแยกบริการจากระบบเดิมแบบเป็นช่วง

รายละเอียดของงาน

  1. แบบจำลองข้อมูลและกฎธุรกิจ

    ระบุข้อมูลหลัก ความสัมพันธ์ เจ้าของข้อมูล และเงื่อนไขที่ทำให้รายการถูกต้อง กำหนดข้อบังคับในฐานข้อมูลและขอบเขต transaction ตามงานจริง

  2. สัญญา API และการตรวจข้อมูล

    กำหนด endpoint รูปแบบ request/response รหัสข้อผิดพลาด และแนวทางเปลี่ยนเวอร์ชัน ตรวจข้อมูลขณะทำงานเพื่อไม่ให้ชนิดข้อมูลในโค้ดเป็นแนวป้องกันเพียงชั้นเดียว

  3. ตัวตนและสิทธิ์การเข้าถึง

    วางการยืนยันตัวตน อายุของ session หรือ token และสิทธิ์ตามบทบาทหรือเจ้าของรายการ ตรวจการอนุญาตฝั่งเซิร์ฟเวอร์ในจุดที่เข้าถึงข้อมูล

  4. การเชื่อมระบบและงานเบื้องหลัง

    ออกแบบ webhook คิวงาน และงานตามเวลา พร้อมแนวทางจัดการรายการซ้ำ retry และรายการที่ต้องตรวจด้วยคน โดยอิงพฤติกรรมของบริการภายนอกแต่ละราย

  5. การย้ายและตรวจข้อมูล

    เตรียม mapping การแปลงข้อมูล การทดสอบย้าย และการตรวจจำนวนหรือยอดที่สำคัญ วางแผนสำรองและวิธีย้อนกลับตามข้อจำกัดของระบบต้นทาง

  6. การทดสอบและการปฏิบัติการ

    ทดสอบกฎธุรกิจ สิทธิ์ และจุดเชื่อมต่อ กำหนด log ที่ไม่เก็บข้อมูลเกินจำเป็น พร้อม health checks และข้อมูลที่ทีมดูแลใช้หาสาเหตุเมื่อเกิดปัญหา

การตัดสินใจในแต่ละช่วง

  1. กำหนดขอบเขตของข้อมูล

    สำรวจแหล่งข้อมูล เจ้าของระบบ ข้อจำกัดของการเชื่อมต่อ และรายการงานที่ต้องรักษาความถูกต้องร่วมกัน

  2. ตกลงสัญญาก่อนเชื่อมจริง

    จัดทำตัวอย่าง API และข้อผิดพลาดให้ทีมหน้าบ้านกับทีมระบบตรวจร่วมกัน ก่อนพัฒนาจุดเชื่อมต่อหลัก

  3. ทดสอบทั้งทางสำเร็จและทางผิดพลาด

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

  4. เปิดใช้งานพร้อมแผนติดตาม

    ทดสอบข้อมูลและการตั้งค่าบน environment ที่ตกลง ส่งมอบคู่มือ deploy การตรวจสถานะ และวิธีจัดการเหตุขัดข้อง

สิ่งที่ส่งต่อให้ทีมคุณ

ไฟล์และเอกสาร

  • ซอร์สโค้ดบริการและชุดทดสอบตามขอบเขต
  • แบบจำลองฐานข้อมูลและไฟล์ migration
  • API specification พร้อมตัวอย่างและรหัสข้อผิดพลาด
  • คู่มือตั้งค่า เชื่อมต่อ deploy และดูแลบริการ

ตรวจรับร่วมกัน

  • API ทำงานตามสัญญาข้อมูลและกฎธุรกิจที่ตกลง
  • กรณีสิทธิ์ไม่ถูกต้องและข้อมูลผิดถูกปฏิเสธพร้อมรหัสสถานะและข้อความที่ระบุสาเหตุ
  • ทีมที่เกี่ยวข้องทดสอบเชื่อมต่อและตรวจขั้นตอนดูแลระบบได้

ข้อมูลและขอบเขตก่อนเริ่ม

ข้อมูลที่ช่วยให้ประเมินงาน

  • ตัวอย่างข้อมูลและกฎที่ระบบต้องตรวจ
  • รายการระบบภายในหรือผู้ให้บริการที่จะเชื่อมต่อ
  • เอกสาร API และสิทธิ์ sandbox หากมี โดยส่งข้อมูลลับผ่านช่องทางที่ตกลง
  • ภาระงานโดยประมาณ เงื่อนไขการย้ายข้อมูล และช่วงเวลาที่เปลี่ยนระบบได้

สิ่งที่ต้องตกลงแยกให้ชัด

  • ค่าบริการฐานข้อมูล โฮสติ้ง และผู้ให้บริการภายนอกจะกำหนดแยกจากค่าพัฒนา
  • ประสิทธิภาพและขีดจำกัดต้องประเมินจากข้อมูลและ workload ที่ตกลง การเพิ่มโครงสร้างพื้นฐานอย่างเดียวไม่แก้ทุกคอขวด
  • งานทดสอบความปลอดภัยโดยผู้ตรวจภายนอก การรับรองมาตรฐาน และการตรวจข้อกฎหมายเฉพาะอุตสาหกรรมต้องกำหนดเพิ่มเติมเมื่อเกี่ยวข้อง

คำถามก่อนตัดสินใจ

เชื่อมกับระบบเดิมโดยไม่เปลี่ยนหน้าจอได้หรือไม่

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

จำเป็นต้องแยกระบบเป็น microservices หรือไม่

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

ทำอย่างไรเมื่อ API ภายนอกล่มหรือส่งข้อมูลซ้ำ

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

รองรับข้อมูลที่มีข้อกำหนดเฉพาะได้หรือไม่

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

ส่งบริบทมา เริ่มจากสิ่งที่มี

อธิบายเป้าหมาย ระบบที่ใช้อยู่ และข้อจำกัดสำคัญ ยังไม่จำเป็นต้องมี requirement ครบทุกข้อ

คุยเรื่องโครงการ