Enfyra
Trung tâm tài liệu

Hiểu Enfyra từ API đến hành vi runtime.

Hướng dẫn, tài liệu tham chiếu và ví dụ để xây dựng với API tự sinh, mô hình metadata, bộ kết nối cơ sở dữ liệu, hook, realtime và các công cụ vận hành của Enfyra.

lộ trình đọctừ tài liệu
Hướng dẫn cài đặt EnfyraHướng dẫn cài đặt Enfyra Điều kiện cần có Node.js >= 24.0.0 nếu cài thủ công Trình quản lý package ( npm , yarn hoặc pnpm ) Máy chủ cơ sở dữ liệu (MySQL, PostgreSQL hoặc MongoDB — MariaDB dùng giao thức mysql:// ) Máy chủ Redis Hoặc dùng Docker để có bộ all-in-one hoàn chỉnh, đượBắt đầuBắt đầu Sau khi cài xong Enfyra backend và app, hãy làm theo các bước sau. Mới dùng Enfyra? Bắt đầu từ Hướng dẫn cài đặt để thiết lập workspace app + server. Đăng nhập lần đầu Mở Enfyra app (mặc định: http://localhost:3000 ). Bạn được chuyển đến trang login. Dùng tài khoản admin Hướng dẫn tạo bảngHướng dẫn tạo bảng Hướng dẫn này đi từ việc tạo bảng đầu tiên đến những gì diễn ra sau khi lưu. Điều kiện: đã hoàn thành Cài đặt và quen với Bắt đầu . Mở màn hình tạo bảng Chọn Collections trên thanh bên. Chọn + Create New Table trong khu vực bên trái. Quan trọng: thứ tự tạo Để rQuản lý dữ liệuQuản lý dữ liệu Data Management là nơi tạo, xem, sửa và xóa bản ghi trong bảng. Sau khi tạo bảng, vào Data ở sidebar rồi chọn bảng. Điều kiện: hoàn thành Cài đặt và Bắt đầu , đồng thời đã tạo ít nhất một bảng theo Hướng dẫn tạo bảng . Cách thao tác dữ liệu hoạt động Mọi thao tác Enfyra Docker – Hướng dẫn sử dụngEnfyra Docker – Hướng dẫn sử dụng Mới dùng Enfyra? Xem Hướng dẫn cài đặt để biết hướng dẫn thiết lập đầy đủ, bao gồm các tùy chọn cài đặt bằng Docker và cài đặt thủ công. Tổng quan Image enfyra/enfyra có thể chạy ở 3 mode khác nhau : all (mặc định) - Chạy server + app + các servi

Bắt đầu

Bắt đầu Phần này hướng dẫn bạn cài đặt Enfyra, đăng nhập lần đầu, tạo dữ liệu và kiểm tra API sinh tự động. Nếu mới dùng Enfyra, hãy đi theo thứ tự các trang dưới đây. Nếu instance của bạn đã chạy, dùng mục điều hướng nhanh để đến thẳng việc cần làm. Điều hướng nhanh Chuẩn bị Enf

Nhóm tài liệu

Bắt đầu

Bắt đầu Phần này hướng dẫn bạn cài đặt Enfyra, đăng nhập lần đầu, tạo dữ liệu và kiểm tra API sinh tự động. Nếu mới dùng Enfyra, hãy đi theo thứ tự các trang dưới đây. Nếu instance của bạn đã chạy, dùng mục điều hướng nhanh để đến thẳng việc cần làm. Điều hướng nhanh Chuẩn bị Enf

Hướng dẫn cài đặt Enfyra

Hướng dẫn cài đặt Enfyra Điều kiện cần có Node.js >= 24.0.0 nếu cài thủ công Trình quản lý package ( npm , yarn hoặc pnpm ) Máy chủ cơ sở dữ liệu (MySQL, PostgreSQL hoặc MongoDB — MariaDB dùng giao thức mysql:// ) Máy chủ Redis Hoặc dùng Docker để có bộ all-in-one hoàn chỉnh, đượ

Bắt đầu

Bắt đầu Sau khi cài xong Enfyra backend và app, hãy làm theo các bước sau. Mới dùng Enfyra? Bắt đầu từ Hướng dẫn cài đặt để thiết lập workspace app + server. Đăng nhập lần đầu Mở Enfyra app (mặc định: http://localhost:3000 ). Bạn được chuyển đến trang login. Dùng tài khoản admin

Hướng dẫn tạo bảng

Hướng dẫn tạo bảng Hướng dẫn này đi từ việc tạo bảng đầu tiên đến những gì diễn ra sau khi lưu. Điều kiện: đã hoàn thành Cài đặt và quen với Bắt đầu . Mở màn hình tạo bảng Chọn Collections trên thanh bên. Chọn + Create New Table trong khu vực bên trái. Quan trọng: thứ tự tạo Để r

Quản lý dữ liệu

Quản lý dữ liệu Data Management là nơi tạo, xem, sửa và xóa bản ghi trong bảng. Sau khi tạo bảng, vào Data ở sidebar rồi chọn bảng. Điều kiện: hoàn thành Cài đặt và Bắt đầu , đồng thời đã tạo ít nhất một bảng theo Hướng dẫn tạo bảng . Cách thao tác dữ liệu hoạt động Mọi thao tác

Enfyra Docker – Hướng dẫn sử dụng

Enfyra Docker – Hướng dẫn sử dụng Mới dùng Enfyra? Xem Hướng dẫn cài đặt để biết hướng dẫn thiết lập đầy đủ, bao gồm các tùy chọn cài đặt bằng Docker và cài đặt thủ công. Tổng quan Image enfyra/enfyra có thể chạy ở 3 mode khác nhau : all (mặc định) - Chạy server + app + các servi

Kiến trúc

Kiến trúc Enfyra là nền tảng backend có thể lập trình. Bạn định nghĩa dữ liệu, route, quyền truy cập, hook, handler, flow và sự kiện realtime bằng metadata; Enfyra biến metadata đó thành API đang chạy mà không cần khởi động lại máy chủ. Trang này mô tả các thành phần chính và luồ

Hướng dẫn

Kiến trúc

Kiến trúc Enfyra là nền tảng backend có thể lập trình. Bạn định nghĩa dữ liệu, route, quyền truy cập, hook, handler, flow và sự kiện realtime bằng metadata; Enfyra biến metadata đó thành API đang chạy mà không cần khởi động lại máy chủ. Trang này mô tả các thành phần chính và luồ

API

API Hướng dẫn xây dựng ứng dụng với Enfyra API. Dùng các endpoint này để xác thực người dùng, đọc và thay đổi dữ liệu, cũng như làm việc với file từ frontend riêng, ứng dụng di động hoặc dịch vụ bên ngoài. Mọi yêu cầu API đều dùng URL của ứng dụng với prefix /api . Base URL {appU

Nhóm tài liệu

API

API Hướng dẫn xây dựng ứng dụng với Enfyra API. Dùng các endpoint này để xác thực người dùng, đọc và thay đổi dữ liệu, cũng như làm việc với file từ frontend riêng, ứng dụng di động hoặc dịch vụ bên ngoài. Mọi yêu cầu API đều dùng URL của ứng dụng với prefix /api . Base URL {appU

Tổng quan API

Tổng quan API Những điểm cốt lõi để gọi API Enfyra từ ứng dụng của bạn. Định dạng URL gốc Mọi endpoint REST của Enfyra dùng dạng: {appUrl}/api/{path} Môi trường appUrl Ví dụ Phát triển cục bộ http://localhost:3000 http://localhost:3000/api/me Production URL ứng dụng đã triển khai

Endpoint xác thực

Endpoint xác thực Mọi URL dùng base {appUrl}/api . POST /login Xác thực bằng email và mật khẩu qua Enfyra app proxy. Ở chế độ SSR/cookie, app lưu Enfyra token trong httpOnly cookie cho bạn. URL: {appUrl}/api/login { "email": "[email protected]", "password": "your_password", "reme

Thao tác CRUD

Thao tác CRUD Khi tạo một bảng trong Enfyra (ví dụ products , orders , customers ), bảng đó tự có các endpoint REST. Dùng chúng để liệt kê, tạo, cập nhật và xóa bản ghi từ ứng dụng của bạn. URL gốc: {appUrl}/api/{routePath} routePath khớp tên bảng hoặc custom route của bạn (ví dụ

Tham số truy vấn

Tham số truy vấn Những tham số này áp dụng cho request GET tới list endpoint (ví dụ GET {appUrl}/api/enfyra_user ). fields Chọn field trả về, cách nhau bằng dấu phẩy. GET {appUrl}/api/enfyra_user?fields=id,email,name,role.name Dùng dot notation cho field liên quan: role.name Dùng

Tệp và lưu trữ

Tệp và lưu trữ Dùng các endpoint này để tải file lên, sắp xếp theo folder và phân phối asset từ ứng dụng. Base URL: {appUrl}/api File Liệt kê file GET {appUrl}/api/enfyra_file?fields=id,filename,mimetype,size,folder&filter={"folder":{"_eq":123}} Tải file lên Dùng multipart/form-d

Tích hợp

Tích hợp Dùng các hướng dẫn này khi bạn muốn kết nối một ứng dụng bên ngoài với Enfyra. Tài liệu tích hợp tập trung vào cách thiết lập framework: quy tắc proxy, auth cookie, luồng OAuth redirect, refresh và realtime transport. Khi kết nối đã xong, hãy dùng các ví dụ để xây dựng t

Nhóm tài liệu

Tích hợp

Tích hợp Dùng các hướng dẫn này khi bạn muốn kết nối một ứng dụng bên ngoài với Enfyra. Tài liệu tích hợp tập trung vào cách thiết lập framework: quy tắc proxy, auth cookie, luồng OAuth redirect, refresh và realtime transport. Khi kết nối đã xong, hãy dùng các ví dụ để xây dựng t

Framework SSR

Framework SSR Kết nối app Nuxt, Next.js, Angular, SvelteKit hoặc Remix với Enfyra bằng REST cùng origin, OAuth cookie, refresh-token support và Socket.IO. Mô hình tích hợp Trình duyệt -> origin của ứng dụng SSR -> tiền tố proxy Enfyra cục bộ -> cầu nối /api và /ws của ứng dụng En

Sử dụng Enfyra với trợ lý lập trình AI

Sử dụng Enfyra với trợ lý lập trình AI Enfyra MCP kết nối dự án Enfyra với các trợ lý lập trình hỗ trợ MCP như Codex, Claude Code, Cursor, VS Code với GitHub Copilot và Google Antigravity. Sau khi kết nối, bạn có thể yêu cầu trợ lý tìm hiểu hoặc thay đổi dự án bằng ngôn ngữ tự nh

Ứng dụng

Ứng dụng Phần này hướng dẫn các phần chạy trong ứng dụng quản trị Enfyra (cổng 3000) : giao diện, tiện ích mở rộng, biểu mẫu, quyền và cách ứng dụng giao tiếp với backend. Đây là một API client : ứng dụng không bao giờ kết nối trực tiếp với cơ sở dữ liệu. Mọi dữ liệu đều đến từ M

Nhóm tài liệu

Ứng dụng

Ứng dụng Phần này hướng dẫn các phần chạy trong ứng dụng quản trị Enfyra (cổng 3000) : giao diện, tiện ích mở rộng, biểu mẫu, quyền và cách ứng dụng giao tiếp với backend. Đây là một API client : ứng dụng không bao giờ kết nối trực tiếp với cơ sở dữ liệu. Mọi dữ liệu đều đến từ M

Tích hợp API

Tích hợp API Enfyra sử dụng thành phần kết hợp useApi cục bộ cung cấp các tương tác API với khả năng xử lý lỗi nâng cao và các tính năng bổ sung. Thành phần kết hợp được xây dựng bằng cách sử dụng $fetch và xử lý tất cả các yêu cầu HTTP đến Máy chủ Enfyra. Từ góc độ của ứng dụng,

Hệ thống biểu mẫu

Hệ thống biểu mẫu Hệ thống biểu mẫu của Enfyra tự động tạo biểu mẫu từ lược đồ cơ sở dữ liệu của bạn. Các biểu mẫu rất năng động, được xác thực và được tích hợp đầy đủ với các quyền và quan hệ. Biểu mẫu hoạt động như thế nào Khi bạn tạo bảng trong Enfyra, hệ thống sẽ tự động tạo

Hệ thống bộ lọc

Hệ thống bộ lọc Hệ thống lọc giúp bạn tìm kiếm và lọc dữ liệu trong bảng của mình. Thay vì cuộn qua nhiều bản ghi, hãy tạo điều kiện tìm kiếm để tìm chính xác thứ bạn cần. Tìm nút Bộ lọc - nó hiển thị "Bộ lọc" bình thường và "Bộ lọc (N)" khi hoạt động. Cách lọc dữ liệu Bắt đầu lọ

Bộ chọn bản ghi liên quan

Bộ chọn bản ghi liên quan Bộ chọn bản ghi liên quan giúp bạn chọn bản ghi có quan hệ khi làm việc với biểu mẫu. Khi thấy biểu tượng bút chì cạnh một trường, đó là trường quan hệ kết nối đến bản ghi ở bảng khác. Thay vì nhập id, bạn có thể duyệt và chọn dữ liệu liên quan trực quan

Trình tạo quyền

Trình tạo quyền Trình tạo quyền là giao diện trực quan để thiết lập các quy tắc kiểm soát truy cập phức tạp. Thay vì viết mã phân quyền, bạn có thể ghép điều kiện bằng các nhóm và toán tử logic. Mở Trình tạo quyền Trường quyền xuất hiện trong nhiều biểu mẫu của Enfyra: Quản lý me

Server

Server Tài liệu này bao quát kiến trúc, API và hướng dẫn phát triển của Enfyra server. Nội dung được tổ chức để giúp bạn tìm thông tin nhanh, dù bạn đang học những điều cơ bản hay tra cứu chi tiết cụ thể. Mới dùng Enfyra? Hãy bắt đầu với Hướng dẫn cài đặt để thiết lập workspace a

Nhóm tài liệu

Server

Server Tài liệu này bao quát kiến trúc, API và hướng dẫn phát triển của Enfyra server. Nội dung được tổ chức để giúp bạn tìm thông tin nhanh, dù bạn đang học những điều cơ bản hay tra cứu chi tiết cụ thể. Mới dùng Enfyra? Hãy bắt đầu với Hướng dẫn cài đặt để thiết lập workspace a

Vòng đời API

Vòng đời API Hiểu cách request API đi qua Enfyra sẽ giúp bạn xây dựng hook và handler hiệu quả. Hướng dẫn này trình bày trọn vẹn vòng đời request và cách đối tượng context đi qua từng giai đoạn. Điều hướng nhanh Tổng quan luồng request - Toàn cảnh vòng đời Các giai đoạn - Giải th

Lọc truy vấn

Lọc truy vấn Enfyra hỗ trợ các toán tử lọc theo phong cách MongoDB để truy vấn dữ liệu. HTTP / REST: truyền điều kiện qua tham số truy vấn filter (JSON trong query string). Handler, hook, flow ( $ctx.$repos.*.find , #table.find , v.v.): truyền cùng điều kiện vào filter khi gọi re

Phương thức Repository

Phương thức Repository Repository là cách chính để làm việc với bảng cơ sở dữ liệu trong Enfyra. Mỗi bảng bạn tạo tự có một repository, truy cập qua $ctx.$repos.tableName . Tham chiếu nhanh Mọi phương thức repository trả dữ liệu theo dạng: { data: [...], // Array of records meta:

Tham chiếu Context

Tham chiếu Context Đối tượng $ctx (context) có mặt trong mọi hook và handler. Nó cho phép truy cập dữ liệu request, repository cơ sở dữ liệu, hàm hỗ trợ, thao tác cache và nhiều thành phần khác. Điều hướng nhanh Dữ liệu request — $ctx.$body , $ctx.$params , $ctx.$query , $ctx.$us

Hooks và Handler

Hooks và Handler Hook và handler cho phép bạn tùy chỉnh hành vi API tại từng điểm trong vòng đời request. Hook chạy trước hoặc sau handler, còn handler chứa logic nghiệp vụ chính. Điều hướng nhanh Tổng quan — Hook và handler là gì preHooks — Chạy trước handler postHooks — Chạy sa

Ví dụ

Ví dụ Dùng các ví dụ này khi bạn cần snippet ngắn có thể dùng ngay, công thức ứng dụng phổ biến hoặc hướng dẫn hoàn chỉnh cho một tính năng. Bắt đầu với ví dụ nhỏ khi cần kiểm tra cú pháp nhanh. Dùng công thức theo nhóm khi bạn đang xây một tính năng sản phẩm thông thường. Dùng h

Nhóm tài liệu

Ví dụ

Ví dụ Dùng các ví dụ này khi bạn cần snippet ngắn có thể dùng ngay, công thức ứng dụng phổ biến hoặc hướng dẫn hoàn chỉnh cho một tính năng. Bắt đầu với ví dụ nhỏ khi cần kiểm tra cú pháp nhanh. Dùng công thức theo nhóm khi bạn đang xây một tính năng sản phẩm thông thường. Dùng h

Ví dụ API

Ví dụ API Các ví dụ REST ngắn cho table route được Enfyra sinh tự động. Thay {appUrl} bằng URL app của bạn, ví dụ http://localhost:3000 . Xác thực Đăng nhập curl -X POST "{appUrl}/api/login" \ -H "Content-Type: application/json" \ -d '{"email":"[email protected]","password":"pass

Ví dụ script

Ví dụ script Các ví dụ nhỏ cho handler, hook, flow và script sự kiện websocket. Đọc repository Tìm các dòng const posts = await #post.find({ fields: "id,title", limit: 10 }) Tìm một dòng const result = await #post.find({ filter: { id: { _eq: @PARAMS.id } }, fields: "id,title", li

Ví dụ ứng dụng

Ví dụ ứng dụng Các ví dụ nhỏ cho Enfyra App extension và ứng dụng SSR bên ngoài. Dữ liệu extension Tải các dòng bằng useApi <script setup> const { data, execute } = useApi("/post", { query: { fields: "id,title", limit: 10 } }) onMounted(() => execute()) </script> Tạo dòng <script

Ví dụ đăng ký người dùng

Ví dụ đăng ký người dùng Xây dựng endpoint công khai POST /register để tạo người dùng một cách an toàn. Ví dụ này dùng một custom route, một pre-hook và một custom handler. Nội dung được giữ gọn để bạn có thể áp dụng mẫu này cho ứng dụng của mình. Nội dung sẽ xây dựng POST /api/r

Ví dụ row-level security

Ví dụ row-level security Xây dựng một bảng dùng chung, trong đó mỗi người dùng chỉ thấy các dòng thuộc tenant của mình. Ví dụ này dùng một quan hệ, một pre-hook và các CRUD route được sinh bình thường. Nội dung sẽ xây dựng enfyra_user -> có tenant project_task -> có tenant -> rou

Enfyra Cloud

Enfyra Cloud Enfyra Cloud là lựa chọn managed hosting cho Enfyra. Dùng Cloud khi bạn muốn đưa một Enfyra project lên mạng mà không phải tự provision server, database, Redis, reverse proxy, TLS và deployment pipeline. Self-hosted Enfyra và Enfyra Cloud cùng dùng một product model:

Hướng dẫn

Enfyra Cloud

Enfyra Cloud Enfyra Cloud là lựa chọn managed hosting cho Enfyra. Dùng Cloud khi bạn muốn đưa một Enfyra project lên mạng mà không phải tự provision server, database, Redis, reverse proxy, TLS và deployment pipeline. Self-hosted Enfyra và Enfyra Cloud cùng dùng một product model: