ข้อมูลทั่วไป
บทนำสู่จุดสิ้นสุด
โมดูลสุดท้ายจบลงด้วยการสร้างกระบวนการทางธุรกิจแรก เราค้นพบวิธีการสร้างตรรกะของกระบวนการ ยอมรับพารามิเตอร์อินพุตเฉพาะ ทำการคำนวณ และออกคำตอบ ยังคงต้องตอบคำถามหลัก จะเปิดใช้งานกระบวนการทางธุรกิจที่สร้างขึ้นและนำไปใช้งานได้อย่างไร?
เพื่อแก้ปัญหานี้ ปลายทางมีจุดประสงค์ - ประเด็นสำคัญของการโต้ตอบกับแอปพลิเคชัน ในโมดูลแรก เราได้โต้ตอบกับ API ภายนอกแล้ว สิ่งนี้เกิดขึ้นได้เนื่องจากการมีจุดสิ้นสุด มีการอธิบายไว้ในเอกสารประกอบ และเราอ่านและทำความเข้าใจว่าวิธีใดและ URL ใดที่จำเป็นในการส่งคำขอเพื่อเข้าถึงทรัพยากรเฉพาะ
เพื่อความเข้าใจ เรามาดูการใช้งานจุดสิ้นสุดโดยใช้ตัวอย่างเฉพาะ ในโมดูลที่สาม แบบจำลองฐานข้อมูลถูกสร้างขึ้น พร้อมกันกับการสร้างตาราง จุดสิ้นสุดจะถูกสร้างขึ้นโดยอัตโนมัติเพื่อโต้ตอบกับตารางเหล่านั้น ไปที่ส่วนปลายทาง (บนแผงด้านซ้าย) แล้วดูที่ส่วนนั้น
ในตัวอย่างตาราง " city " ที่มีข้อมูลเกี่ยวกับเมือง จะเห็นได้ว่ามี 6 ปลายทางสำหรับการดำเนินการข้อมูลพื้นฐานแล้ว
- GET /city - รับข้อมูลทั้งหมดจากตาราง
- GET /city/:id - รับข้อมูลเกี่ยวกับเมืองด้วยรหัสที่ระบุ
- POST /city - เพิ่มระเบียนใหม่ลงในตาราง
- PUT /city/:id - แทนที่บันทึกทั้งหมดด้วยรหัสที่ระบุในตาราง
- PATCH /city/:id - การแทนที่บันทึกบางส่วนด้วยรหัสที่ระบุในตาราง
- DELETE /city/:id - การลบบันทึกที่มีรหัสที่ระบุออกจากตาราง
การตั้งค่าทั่วไป
คุณสามารถเปิดการตั้งค่าสำหรับแต่ละจุดสิ้นสุดและศึกษารายละเอียดเพิ่มเติมได้ ตัวอย่างเช่น พิจารณาปลายทาง GET /city/:id
ภาพที่เราเห็นคล้ายกับที่เราเคยเห็นเมื่อสร้างคำขอไปยัง API ภายนอก ในกรณีหนึ่ง เราเข้าถึงเฉพาะตำแหน่งข้อมูลสำเร็จรูป และตอนนี้เรากำลังสร้างและกำหนดค่าตำแหน่งข้อมูลนี้ด้วยตนเอง ในการกำหนดค่า คุณต้องระบุ:
- วิธีการขอ ในตัวอย่างนี้ นี่คือ GET
- ขอ URL ไม่ได้ระบุส่วนแรกที่มีเส้นทางไปยังเซิร์ฟเวอร์ ซึ่งเหมือนกันกับทุกปลายทางของแอปพลิเคชัน การระบุเฉพาะส่วนท้าย ( /city ) ก็เพียงพอแล้ว มีการระบุพารามิเตอร์ URL ที่นี่ด้วย จุดสิ้นสุดถูกออกแบบมาเพื่อรับข้อมูลเกี่ยวกับเมืองใดเมืองหนึ่ง ดังนั้น id ที่เขียนตามหลัง “:” จะถูกส่งผ่านเป็นพารามิเตอร์
- Endpoint Groups พารามิเตอร์นี้ไม่ส่งผลกระทบต่อการทำงานของอุปกรณ์ปลายทางแต่อย่างใด และมีไว้เพื่อความสะดวกขององค์กรเท่านั้น จุดสิ้นสุดทั้งหมดสามารถแบ่งออกเป็นกลุ่มเฉพาะเรื่อง (โฟลเดอร์) ในตัวอย่างนี้ กลุ่ม " city " มีจุดสิ้นสุดทั้งหมดสำหรับการทำงานกับข้อมูลในเมือง
- Business Process นี่คือรายการการกำหนดค่าที่สำคัญที่สุดและเป็นสิ่งที่ไม่สามารถมองเห็นได้ในทางใดทางหนึ่งเมื่อส่งคำขอไปยังจุดสิ้นสุด การระบุกระบวนการทางธุรกิจจะเป็นตัวกำหนดว่าจุดสิ้นสุดนี้จะทำอะไร ในเวลาเดียวกัน จุดสิ้นสุดนั้นไม่สามารถเปลี่ยนแปลงได้ โดยจะได้รับคำขอเดียวกันทั้งหมดที่ที่อยู่เดิม และในขณะเดียวกัน หากกระบวนการทางธุรกิจถูกแทนที่ ก็จะทำหน้าที่ที่แตกต่างไปจากเดิมอย่างสิ้นเชิง กระบวนการทางธุรกิจสำหรับกิจกรรมฐานข้อมูลพื้นฐานจะถูกสร้างขึ้นโดยอัตโนมัติ พวกเขาเรียกว่ากระบวนการทางธุรกิจของระบบ BP ดังกล่าวไม่สามารถเปลี่ยนแปลงได้ แต่สามารถเปลี่ยนได้ตลอดเวลาด้วย BP ที่สร้างขึ้นโดยอิสระด้วยกระบวนการทางธุรกิจที่กำหนดเอง
- Input/Output variables กระบวนการทางธุรกิจที่สร้างขึ้นใช้ตัวแปรอินพุตและเอาต์พุตต่างๆ แต่ปลายทางไม่จำเป็นต้องใช้ตัวแปรเหล่านี้ทั้งหมด สามารถปิดใช้งานหรือกำหนดค่าชิ้นส่วนเพื่อให้จุดสิ้นสุดต่างๆ เข้าถึง BP เดียวกันด้วยชุดตัวแปรแต่ละชุด คำขอและประเภทการตอบสนอง ( ประเภท Request / Response type ) ได้รับการกำหนดค่าที่นั่นด้วย ส่วนใหญ่แล้วประเภทนี้จะเป็น JSON แต่หากจำเป็น สามารถใช้ตัวเลือกอื่นๆ ได้ เช่น XML หรือ Render File (การตอบสนองประเภทนี้ใช้ในจุดสิ้นสุดสำหรับการทำงานกับไฟล์)
การตั้งค่ามิดเดิลแวร์
การตั้งค่าทั่วไปเพียงพอสำหรับการสร้างและใช้ปลายทางเพิ่มเติม แต่สามารถใช้พารามิเตอร์เพิ่มเติมได้หากจำเป็น สิ่งที่สำคัญที่สุดคือการเปิดใช้งาน Middleware ด้วยโทเค็นการ Auth
การใช้งานทำให้คุณสามารถปฏิเสธการเข้าถึงปลายทางนี้สำหรับผู้ใช้ที่ไม่ได้รับอนุญาตหรือไม่ได้อยู่ในกลุ่มใดกลุ่มหนึ่ง (เช่น การเข้าถึงสามารถให้เฉพาะผู้ดูแลระบบและปฏิเสธสำหรับผู้ใช้รายอื่น)
การตั้งค่าการบันทึกและเอาต์พุต
นอกจากนี้ คุณสามารถใช้การตั้งค่าบนแท็บ Settings เพื่อเพิ่มส่วนหัวของบันทึกหรือเนื้อหาคำขอ รวมทั้งซ่อนจากการตอบสนองของฟิลด์ที่ไม่ได้ตั้งค่าไว้