Giao diện
Tham chiếu API
Tổng quan endpoints
| Endpoint | Method | Mô tả |
|---|---|---|
customRequests:send | POST | Resolve template và gửi HTTP request đến URL đích |
customRequests:listByCurrentRole | GET | Lấy danh sách request mà role hiện tại được phép dùng |
customRequests:get | GET | Lấy chi tiết một cấu hình request |
customRequests:create | POST | Tạo cấu hình mới (admin) |
customRequests:update | PUT | Sửa cấu hình (admin) |
customRequests:destroy | DELETE | Xóa cấu hình (admin) |
customRequests:list | GET | Liệt kê tất cả cấu hình (admin) |
customRequests:send
Endpoint chính — resolve template variables rồi gửi HTTP request.
Method: POST
Request body:
| Tham số | Kiểu | Bắt buộc | Mô tả |
|---|---|---|---|
key | string | Có | Khóa định danh của custom request |
currentRecord | object | Không | Dữ liệu bản ghi hiện tại (client gửi lên) |
$nForm | object | Không | Dữ liệu form hiện tại |
Luồng xử lý server:
- Đọc cấu hình từ bảng
customRequeststheokey. - Kiểm tra role hiện tại có quyền sử dụng (qua
customRequestsRoles). - Resolve template variables trong URL, headers, body — thay thế biến
currentRecord,currentUser,$nFormbằng giá trị thực (template parsing). - Gửi HTTP request đến URL đích qua axios.
- Ghi log kết quả vào file logger.
- Trả response từ hệ thống đích về client.
Response: Trả về response body từ hệ thống đích (pass-through).
customRequests:listByCurrentRole
Lấy danh sách request mà user hiện tại được phép sử dụng (dựa trên role).
Method: GET
Response: Mảng cấu hình request đã lọc theo role.
customRequests:get
Method: GET
Query params:
| Tham số | Kiểu | Mô tả |
|---|---|---|
filterByTk | string | Key của request cần lấy |
Response: Object cấu hình request.
Database schema
Bảng customRequests
| Cột | Kiểu | Mô tả |
|---|---|---|
key | string (PK) | Khóa định danh duy nhất |
options | JSON | Cấu hình request: url, method, headers, body, params |
roles | belongsToMany | Quan hệ M2M qua bảng customRequestsRoles |
createdAt | datetime | Thời gian tạo |
updatedAt | datetime | Thời gian cập nhật |
Bảng customRequestsRoles (junction)
| Cột | Kiểu | Mô tả |
|---|---|---|
customRequestKey | string (FK) | Tham chiếu customRequests.key |
roleName | string (FK) | Tham chiếu roles.name |
ACL
| Quyền | Loại | Mô tả |
|---|---|---|
ui.* | Snippet | Cho phép truy cập UI quản lý custom requests |
customRequests:send | Action | User đã đăng nhập — gửi request |
customRequests:listByCurrentRole | Action | User đã đăng nhập — lấy danh sách |
customRequests CRUD | Resource | Chỉ admin — quản trị cấu hình |