JSON-Server: REST API Giả Lập Từ File JSON

JSON-Server Là Gì?

JSON-Server là công cụ Node.js đọc một file db.json (hoặc db.json5) và phục vụ các khoá cấp cao nhất của nó như tài nguyên REST, nên một mảng posts trở thành các route GET/POST/PUT/PATCH/DELETE tại /posts. Chạy nó bằng npx json-server db.json sẽ khởi động server HTTP ở cổng 3000, dựa trên dữ liệu trong file đó. Tham số truy vấn xử lý lọc, sắp xếp, và phân trang mà không cần cấu hình thêm.

Tính Năng Chính Để Tạo API Giả Lập

• ✓Đầy đủ route CRUD cho tài nguyên dạng mảng: GET, POST, PUT, PATCH, và DELETE trên /posts, được tạo trực tiếp từ cấu trúc file JSON.
• ✓Lọc theo truy vấn với toán tử tường minh — field:operator=value — bao gồm eq, ne, lt, lte, gt, gte, in, contains, startsWith, và endsWith.
• ✓Sắp xếp qua _sort, kể cả thứ tự giảm dần với dấu trừ ở đầu, và sắp xếp nhiều trường như _sort=author.name,-views.
• ✓Phân trang qua _page và _per_page, mặc định 10 mục mỗi trang, trả về metadata first/prev/next/last/pages/items kèm theo data.
• ✓Nhúng quan hệ với _embed, nên GET /posts?_embed=comments gắn kèm comment của mỗi post ngay trong response.
• ✓Truy vấn boolean phức tạp qua _where, nhận một object JSON thô để lọc, và ghi đè các tham số truy vấn đơn giản khi có mặt.
• ✓Tự động phục vụ file tĩnh từ ./public, và có thể thêm thư mục file tĩnh khác qua cờ -s.
• ✓Xoá theo chuỗi phụ thuộc với _dependent, nên DELETE /posts/1?_dependent=comments sẽ xoá luôn comment của post đó.

Khi Nào Nên Dùng JSON-Server

• •Xây dựng frontend dựa trên endpoint REST thật trước khi đội backend triển khai xong bất cứ thứ gì.
• •Viết integration test cần request/response HTTP thật thay vì mock fetch giả.
• •Prototype nhanh một data model bằng cách chỉnh sửa trực tiếp db.json và thấy route cập nhật ngay.
• •Demo ứng dụng với file tĩnh phục vụ song song dữ liệu API, nhờ hỗ trợ thư mục ./public sẵn có.

Bắt Đầu: Cài Đặt

Cài json-server như một dependency của dự án bằng `npm install json-server`. README không hướng dẫn cài đặt global; ví dụ sử dụng chạy thẳng qua npx (`npx json-server db.json`), hoạt động dù bạn có cài local hay không. Chạy `json-server --help` để xem đầy đủ tuỳ chọn CLI — README không liệt kê hết các cờ ngay trong văn bản, nên lệnh đó mới là tài liệu tham khảo thật cho các cờ như -s cho thư mục file tĩnh.

Tạo Và Truy Cập API Giả Lập

Tạo một file db.json với các mảng và object ở cấp cao nhất, ví dụ một mảng posts với trường id/title/views, cùng một mảng comments tham chiếu tới postId. Định dạng JSON5 cũng được hỗ trợ (db.json5), cho phép viết comment và dấu phẩy thừa trong file. Khởi động server bằng `npx json-server db.json`; nó lắng nghe tại http://localhost:3000 và log địa chỉ đó khi khởi động. Từ đó, `curl http://localhost:3000/posts/1` trả về post tương ứng dạng JSON, và mảng đó trở thành route CRUD đầy đủ tại /posts. Tham số truy vấn cộng thêm khả năng lọc, sắp xếp, phân trang, nhúng quan hệ, và lọc phức tạp qua _where.

Lựa Chọn Thay Thế Cho JSON-Server

Câu Hỏi Thường Gặp

Vấn đề JSON-Server giải quyết

Công việc frontend thường bị đình trệ cho tới khi có backend thật, hoặc team tự viết mock fetch tạm bợ rồi lệch dần khỏi hành vi HTTP thật: sai status code, phân trang không thật, chuỗi truy vấn không được phân tích đúng. JSON-Server biến một file JSON thành các route phản hồi như một REST API thật, gồm CRUD với status phù hợp, lọc theo toán tử, và metadata phân trang, để code frontend và test có thể gọi thẳng vào endpoint HTTP thật trước khi đội backend triển khai xong.

Ai nên dùng — và ai nên bỏ qua

Hãy dùng JSON-Server nếu bạn đang xây frontend hoặc viết test và muốn có request HTTP thật tới các route CRUD mà không cần dựng database và backend framework. Nó phù hợp với team cần hành vi lọc, sắp xếp, và phân trang trông chân thực trong lúc phát triển. Bỏ qua nếu bạn cần xác thực, phân quyền, hay quy tắc nghiệp vụ được thực thi ở phía server — đó là điều một mock server dựa trên file JSON không hướng tới, và bạn sẽ phải gắn thêm middleware hoặc chuyển sang backend thật.

Repo liên quan