#Nguồn dữ liệu REST API

#Giới thiệu

Dùng để kết nối dữ liệu từ nguồn REST API.

#Cài đặt

Plugin này là plugin thương mại. Để biết chi tiết về cách kích hoạt, vui lòng tham khảo：Hướng dẫn kích hoạt plugin thương mại

#Thêm nguồn REST API

Sau khi kích hoạt plugin, chọn REST API trong menu thả xuống Add new của phần quản lý nguồn dữ liệu.

Cấu hình nguồn REST API

#Thêm Collection

Tài nguyên RESTful chính là Collection của NocoBase, chẳng hạn như tài nguyên Users.

GET /users
POST /users
GET /users/1
PUT /users/1
DELETE /users/1

Cấu hình ánh xạ vào API của NocoBase là

GET /users:list
POST /users:create
POST /users:get?filterByTk=1
POST /users:update?filterByTk=1
POST /users:destroy?filterByTk=1

Để xem đầy đủ quy chuẩn thiết kế API của NocoBase, tham khảo tài liệu API

Xem chương 「NocoBase API - Core」

Cấu hình Collection của nguồn dữ liệu REST API như sau

#List

Cấu hình ánh xạ API để xem danh sách tài nguyên

#Get

Cấu hình ánh xạ API để xem chi tiết tài nguyên

#Create

Cấu hình ánh xạ API để tạo tài nguyên

#Update

Cấu hình ánh xạ API để cập nhật tài nguyên

#Destroy

Cấu hình ánh xạ API để xóa tài nguyên

Trong đó, List và Get là hai API bắt buộc phải cấu hình.

#Gỡ lỗi API

#Kết nối tham số yêu cầu

Ví dụ: cấu hình tham số phân trang cho API List (nếu API bên thứ ba không hỗ trợ phân trang thì sẽ phân trang dựa trên dữ liệu danh sách đã lấy được).

Lưu ý rằng chỉ các biến đã được thêm vào API mới có hiệu lực.

Có thể nhấp vào Try it out để gỡ lỗi và xem kết quả phản hồi.

#Chuyển đổi định dạng phản hồi

Định dạng phản hồi của API bên thứ ba có thể không phải là định dạng chuẩn của NocoBase, cần chuyển đổi trước khi có thể hiển thị chính xác trên giao diện người dùng.

Điều chỉnh quy tắc chuyển đổi theo định dạng phản hồi của API bên thứ ba để phù hợp với tiêu chuẩn đầu ra của NocoBase.

Mô tả quy trình gỡ lỗi

#Chuyển đổi thông tin lỗi

Khi API bên thứ ba xảy ra lỗi, định dạng thông tin lỗi trong phản hồi có thể không phải là định dạng chuẩn của NocoBase, cần chuyển đổi trước khi có thể hiển thị chính xác trên giao diện người dùng.

Nếu chưa cấu hình chuyển đổi thông tin lỗi, mặc định sẽ chuyển đổi thành thông tin lỗi chứa mã trạng thái HTTP.

Sau khi cấu hình chuyển đổi thông tin lỗi, thông tin sẽ phù hợp với tiêu chuẩn đầu ra của NocoBase và giao diện người dùng có thể hiển thị chính xác thông tin lỗi của API bên thứ ba.

#Biến

Nguồn dữ liệu REST API cung cấp ba loại biến để kết nối với API

• Biến tùy chỉnh của nguồn dữ liệu
• Yêu cầu NocoBase
• Phản hồi bên thứ ba

#Biến tùy chỉnh của nguồn dữ liệu

#Yêu cầu NocoBase

• Params: tham số truy vấn URL (Search Params), Params của mỗi API có thể khác nhau;
• Headers: phần thân yêu cầu, chủ yếu cung cấp một số thông tin X- tùy chỉnh của NocoBase;
• Body: Body của yêu cầu;
• Token: API token của yêu cầu NocoBase hiện tại.

#Phản hồi bên thứ ba

Hiện tại chỉ cung cấp Body của phản hồi

Các biến có thể sử dụng khi kết nối với từng API như sau:

#List

#Get

#Create

#Update

#Destroy

#Cấu hình trường

Trích xuất siêu dữ liệu trường (Fields) từ dữ liệu của các API CRUD của tài nguyên đã tích hợp để làm các trường của collection.

Trích xuất siêu dữ liệu trường.

Trường và bản xem trước.

Chỉnh sửa trường (tương tự như cách thực hiện với các nguồn dữ liệu khác).

#Thêm block nguồn dữ liệu REST API

Sau khi cấu hình Collection, bạn có thể thêm block trên giao diện.