#Data Source REST API

#Giới thiệu

Dùng để tích hợp 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 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 dropdown menu Add new của Data Source Manager.

Cấu hình nguồn REST API

#Thêm Collection

Tài nguyên RESTful chính là Collection của NocoBase, ví dụ tài nguyên Users

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

Khi ánh xạ vào API NocoBase sẽ được cấu hình như sau

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

Quy chuẩn thiết kế API NocoBase đầy đủ tham khảo tài liệu API

Xem chương "NocoBase API - Core"

Cấu hình Collection của Data Source 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.

#Debug API

#Mapping tham số request

Ví dụ: Cấu hình tham số phân trang cho API List (nếu third-party API 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 ý, chỉ có các biến đã được thêm vào trong API mới có hiệu lực.

Bạn có thể nhấn Try it out để debug, xem kết quả response.

#Chuyển đổi format response

Format response của third-party API có thể không phải là chuẩn NocoBase, cần được chuyển đổi mới có thể hiển thị đúng ở frontend.

Điều chỉnh quy tắc chuyển đổi theo format response của third-party API, sao cho phù hợp với chuẩn output của NocoBase.

Mô tả quy trình debug

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

Khi third-party API xảy ra lỗi, format thông tin lỗi response có thể không phải chuẩn NocoBase, cần được chuyển đổi mới có thể hiển thị đúng ở frontend.

Khi không 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 http status code.

Sau khi cấu hình chuyển đổi thông tin lỗi, để phù hợp với chuẩn output của NocoBase, frontend có thể hiển thị đúng thông tin lỗi của third-party API.

#Biến (Variables)

Data Source REST API cung cấp ba loại biến dùng để tích hợp API

• Biến tùy chỉnh của Data Source
• NocoBase request
• Third-party response

#Biến tùy chỉnh của Data Source

#NocoBase request

• Params: URL query parameters (Search Params), Params của mỗi API có sự khác nhau;
• Headers: Request body, chủ yếu cung cấp một số thông tin X- tùy chỉnh của NocoBase;
• Body: Body của request;
• Token: API token của request NocoBase hiện tại.

#Third-party response

Hiện tại chỉ cung cấp Body của response

Các biến có thể sử dụng khi tích hợp với mỗi API như sau:

#List

#Get

#Create

#Update

#Destroy

#Cấu hình Field

Từ dữ liệu của API CRUD của tài nguyên đã được adapt, trích xuất metadata của field (Fields) làm field của Collection.

Trích xuất metadata của field.

Field và preview.

Chỉnh sửa field (tương tự cách của các Data Source khác).

#Thêm block Data Source REST API

Sau khi cấu hình Collection xong, bạn có thể vào giao diện để thêm block.