เอกสารนี้แปลโดย AI หากมีข้อมูลที่ไม่ถูกต้อง โปรดดูเวอร์ชันภาษาอังกฤษ
แหล่งข้อมูล REST API
This feature is provided by the commercial plugin «แหล่งข้อมูล: REST API», please purchase to useบทนำ
ปลั๊กอินนี้ช่วยให้คุณสามารถเชื่อมต่อข้อมูลจากแหล่งข้อมูล REST API ได้อย่างราบรื่นครับ/ค่ะ
การติดตั้ง
ปลั๊กอินนี้เป็นปลั๊กอินเชิงพาณิชย์ครับ/ค่ะ คุณจะต้องอัปโหลดและเปิดใช้งานผ่านตัวจัดการปลั๊กอินก่อนนะครับ/คะ
การเพิ่มแหล่งข้อมูล REST API
หลังจากเปิดใช้งานปลั๊กอินแล้ว คุณสามารถเพิ่มแหล่งข้อมูล REST API ได้โดยเลือก 'REST API' จากเมนูแบบเลื่อนลง 'Add new' ในส่วนการจัดการแหล่งข้อมูลครับ/ค่ะ
กำหนดค่าแหล่งข้อมูล REST API ครับ/ค่ะ
การเพิ่มคอลเลกชัน
ใน NocoBase ทรัพยากรแบบ RESTful จะถูกแมปเข้ากับ คอลเลกชัน ครับ/ค่ะ เช่น ทรัพยากร Users
ปลายทาง API เหล่านี้จะถูกแมปใน NocoBase ดังนี้ครับ/ค่ะ:
สำหรับคู่มือฉบับสมบูรณ์เกี่ยวกับข้อกำหนดการออกแบบ NocoBase API โปรดดูเอกสารประกอบ API ครับ/ค่ะ
ตรวจสอบบท "NocoBase API - Core" สำหรับข้อมูลโดยละเอียดครับ/ค่ะ
การกำหนดค่า คอลเลกชัน สำหรับแหล่งข้อมูล REST API มีดังต่อไปนี้ครับ/ค่ะ:
List
แมปอินเทอร์เฟซสำหรับการดูรายการทรัพยากรครับ/ค่ะ
Get
แมปอินเทอร์เฟซสำหรับการดูรายละเอียดทรัพยากรครับ/ค่ะ
Create
แมปอินเทอร์เฟซสำหรับการสร้างทรัพยากรครับ/ค่ะ
Update
แมปอินเทอร์เฟซสำหรับการอัปเดตทรัพยากรครับ/ค่ะ
Destroy
แมปอินเทอร์เฟซสำหรับการลบทรัพยากรครับ/ค่ะ
อินเทอร์เฟซ List และ Get เป็นสองอินเทอร์เฟซที่จำเป็นต้องกำหนดค่าครับ/ค่ะ
การดีบัก API
การรวมพารามิเตอร์คำขอ
ตัวอย่าง: กำหนดค่าพารามิเตอร์การแบ่งหน้าสำหรับ List API ครับ/ค่ะ หาก API ของบุคคลที่สามไม่รองรับการแบ่งหน้าโดยตรง NocoBase จะทำการแบ่งหน้าตามข้อมูลรายการที่ดึงมาได้ครับ/ค่ะ
โปรดทราบว่า ตัวแปรที่เพิ่มในอินเทอร์เฟซเท่านั้นที่จะมีผลครับ/ค่ะ
| ชื่อพารามิเตอร์ API ของบุคคลที่สาม | พารามิเตอร์ NocoBase |
|---|---|
| page | {{request.params.page}} |
| limit | {{request.params.pageSize}} |
คุณสามารถคลิก 'Try it out' เพื่อดีบักและดูผลลัพธ์การตอบกลับได้ครับ/ค่ะ
การแปลงรูปแบบการตอบกลับ
รูปแบบการตอบกลับของ API บุคคลที่สามอาจไม่เป็นไปตามมาตรฐานของ NocoBase ครับ/ค่ะ จึงจำเป็นต้องแปลงก่อนที่จะแสดงผลได้อย่างถูกต้องบนส่วนหน้า
ปรับกฎการแปลงตามรูปแบบการตอบกลับของ API บุคคลที่สาม เพื่อให้แน่ใจว่าผลลัพธ์ที่ได้เป็นไปตามมาตรฐานของ NocoBase ครับ/ค่ะ
คำอธิบายขั้นตอนการดีบัก
ตัวแปร
แหล่งข้อมูล REST API รองรับตัวแปรสามประเภทสำหรับการเชื่อมต่อ API ครับ/ค่ะ:
- ตัวแปรแหล่งข้อมูลที่กำหนดเอง
- ตัวแปรคำขอ NocoBase
- ตัวแปรการตอบกลับของบุคคลที่สาม
ตัวแปรแหล่งข้อมูลที่กำหนดเอง
คำขอ NocoBase
- Params: พารามิเตอร์การสืบค้น URL (Search Params) ซึ่งจะแตกต่างกันไปตามแต่ละอินเทอร์เฟซครับ/ค่ะ
- Headers: ส่วนหัวคำขอที่กำหนดเอง ซึ่งส่วนใหญ่จะให้ข้อมูล X- เฉพาะจาก NocoBase ครับ/ค่ะ
- Body: เนื้อหาของคำขอครับ/ค่ะ
- Token: โทเค็น API สำหรับคำขอ NocoBase ปัจจุบันครับ/ค่ะ
การตอบกลับของบุคคลที่สาม
ปัจจุบันมีเพียงเนื้อหาการตอบกลับ (response body) เท่านั้นที่ใช้งานได้ครับ/ค่ะ
ตัวแปรที่ใช้งานได้สำหรับแต่ละอินเทอร์เฟซมีดังนี้ครับ/ค่ะ:
List
| พารามิเตอร์ | คำอธิบาย |
|---|---|
| request.params.page | หน้าปัจจุบัน |
| request.params.pageSize | จำนวนรายการต่อหน้า |
| request.params.filter | เกณฑ์การกรอง (ต้องเป็นไปตามรูปแบบ Filter ของ NocoBase) |
| request.params.sort | เกณฑ์การจัดเรียง (ต้องเป็นไปตามรูปแบบ Sort ของ NocoBase) |
| request.params.appends | ฟิลด์ที่โหลดตามความต้องการ โดยทั่วไปใช้สำหรับฟิลด์ความสัมพันธ์ |
| request.params.fields | ฟิลด์ที่จะรวม (รายการที่อนุญาต) |
| request.params.except | ฟิลด์ที่จะยกเว้น (รายการที่ไม่อนุญาต) |
Get
| พารามิเตอร์ | คำอธิบาย |
|---|---|
| request.params.filterByTk | จำเป็นต้องระบุ โดยทั่วไปคือ ID ของเรคคอร์ดปัจจุบัน |
| request.params.filter | เกณฑ์การกรอง (ต้องเป็นไปตามรูปแบบ Filter ของ NocoBase) |
| request.params.appends | ฟิลด์ที่โหลดตามความต้องการ โดยทั่วไปใช้สำหรับฟิลด์ความสัมพันธ์ |
| request.params.fields | ฟิลด์ที่จะรวม (รายการที่อนุญาต) |
| request.params.except | ฟิลด์ที่จะยกเว้น (รายการที่ไม่อนุญาต) |
Create
| พารามิเตอร์ | คำอธิบาย |
|---|---|
| request.params.whiteList | รายการที่อนุญาต |
| request.params.blacklist | รายการที่ไม่อนุญาต |
| request.body | ข้อมูลเริ่มต้นสำหรับการสร้าง |
Update
| พารามิเตอร์ | คำอธิบาย |
|---|---|
| request.params.filterByTk | จำเป็นต้องระบุ โดยทั่วไปคือ ID ของเรคคอร์ดปัจจุบัน |
| request.params.filter | เกณฑ์การกรอง (ต้องเป็นไปตามรูปแบบ Filter ของ NocoBase) |
| request.params.whiteList | รายการที่อนุญาต |
| request.params.blacklist | รายการที่ไม่อนุญาต |
| request.body | ข้อมูลสำหรับอัปเดต |
Destroy
| พารามิเตอร์ | คำอธิบาย |
|---|---|
| request.params.filterByTk | จำเป็นต้องระบุ โดยทั่วไปคือ ID ของเรคคอร์ดปัจจุบัน |
| request.params.filter | เกณฑ์การกรอง (ต้องเป็นไปตามรูปแบบ Filter ของ NocoBase) |
การกำหนดค่าฟิลด์
ข้อมูลเมตาของฟิลด์ (Fields) จะถูกดึงมาจากข้อมูลอินเทอร์เฟซ CRUD ของทรัพยากรที่ปรับใช้ เพื่อใช้เป็นฟิลด์ของ คอลเลกชัน ครับ/ค่ะ
ดึงข้อมูลเมตาของฟิลด์ครับ/ค่ะ
ฟิลด์และการแสดงตัวอย่าง
แก้ไขฟิลด์ (คล้ายกับแหล่งข้อมูลอื่น ๆ ครับ/ค่ะ)
การเพิ่มบล็อกแหล่งข้อมูล REST API
เมื่อกำหนดค่า คอลเลกชัน เรียบร้อยแล้ว คุณสามารถเพิ่มบล็อกไปยังอินเทอร์เฟซได้เลยครับ/ค่ะ
