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. Vui lòng tham khảo Hướng dẫn kích hoạt plugin thương mại để biết cách kích hoạt chi tiết.

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.

20240721171420

Cấu hình nguồn REST API

20240721171507

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ạ trong API NocoBase như sau:

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

Tham khảo tài liệu API để biết đầy đủ đặc tả thiết kế API của NocoBase.

20240716213344

Xem chương 「NocoBase API - Core」

20240716213258

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

List

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

20251201162457

Get

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

20251201162744

Create

Cấu hình ánh xạ giao diện để tạo tài nguyên.

20251201163000

Update

Cấu hình ánh xạ giao diện để cập nhật tài nguyên. 20251201163058

Destroy

Cấu hình ánh xạ giao diện để xóa tài nguyên.

20251201163204

Trong đó, List và Get là hai giao diện 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 giao diện 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).

20251201163500

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

Tên tham số kết nối API bên thứ ba	Tham số NocoBase
page	{{request.params.page}}
limit	{{request.params.pageSize}}

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

20251201163635

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 tiêu 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.

20251201164529

Đ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.

20251201164629

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

20240717110051

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 tiêu 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.

20251201170545

Khi chưa cấu hình chuyển đổi thông tin lỗi, hệ thống mặc định chuyển đổi thành thông tin lỗi bao gồm mã trạng thái HTTP.

20251201170732

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.

20251201170946 20251201171113

Biến

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

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

20240716221937

20240716221858

Yêu cầu NocoBase

Params: tham số truy vấn URL (Search Params), Params của mỗi giao diện 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.

20251201164833

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

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

20251201164915

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

List

Tham số	Mô tả
request.params.page	Số trang hiện tại
request.params.pageSize	Số lượng mỗi trang
request.params.filter	Điều kiện lọc (phải phù hợp với định dạng Filter của NocoBase)
request.params.sort	Quy tắc sắp xếp (phải phù hợp với định dạng Sort của NocoBase)
request.params.appends	Các trường tải theo nhu cầu, thường dùng để tải theo nhu cầu các trường quan hệ
request.params.fields	Các trường mà giao diện chỉ xuất ra (danh sách trắng)
request.params.except	Các trường cần loại trừ (danh sách đen)