Cách tạo REST API với JSON Server
- Báo cáo
Một việc làm khá thông dụng so với front-end developer là phải giả lập một backend REST service để nhận JSON data phân phối cho ứng dụng front-end, và bảo vệ nó hoạt động giải trí như mong đợi trong khi đang chờ phía backend hoàn thành xong service .Nội dung chính
- Cách tạo REST API với JSON Server
- Cài đặt JSON Server
- Tạo JSON File
- Khởi động Server
- Deploy bằng địa chỉ IP
Bạn vẫn hoàn toàn có thể setup backend server không thiếu, bằng cách sử dụng Node. js, Express và MongoDB, tuy nhiên việc này tốn khá nhiều thời hạn và phức tạp. Trong khi đó JSON Server lại là một giải pháp khá triển khai xong cho nhu yếu nhanh và đơn thuần với vừa đủ những CRUD operation .
Vì vậy bài viết này sẽ hướng dẫn bạn cách cài đặt JSON server và publish một sample REST API.
Cài đặt JSON Server
JSON Server được đóng gói như một NPM package. Vì vậy việc setup hoàn toàn có thể được triển khai trải qua việc sử dụng gói Node. js manager :
$ npm install -g json-server
Tuỳ chọn – g sẽ giúp cho package được thiết lập ở level mạng lưới hệ thống .
Tạo JSON File
Tiếp theo, hãy tạo file JSON với tên data.json. Trong file này sẽ chứa những tài liệu được trả về bởi REST API. Dưới đây là một ví dụ về file json này :
{ "employees": [ { "id": 1, "first_name": "Sebastian", "last_name": "Nommand", "address": "123 Subway, NDC" }, { "id": 2, "first_name": "Julia", "last_name": "Palmer", "address": "Path 12, Manchess Street" }, { "id": 3, "first_name": "Anne", "last_name": "Cathays", "address": "4th floor, Nanman Landing" } ]
}Cấu trúc trên miêu tả employee object với những trường id, first_name, last_name và address .
Khởi động Server
Hãy khởi động JSON server bằng việc chạy câu lệnh sau :
$ json-server --watch data.json
File data.json được truyền vào như một tham số trong câu lệnh trên, và option — watch được thêm vào nhằm mục đích bảo vệ server được start ở watch mode, trong mode này, server sẽ xem chừng cho những biến hóa của file và update tác dụng vào API một cách tương thích .Bây giờ hãy mở địa chỉ http://localhost:3000/employees trên browser và ta sẽ nhận được tác dụng của file json mà ta đã tạo .Những HTTP endpoints sau đây được tạo tự động hóa bởi JSON server, ta hoàn toàn có thể tuỳ chọn để sử dụng sao cho tương thích với mục tiêu của mình :
GET /employees
GET /employees/{id}
POST /employees
PUT /employees/{id}
PATCH /employees/{id}
DELETE /employees/{id}Ngoài ra ta còn hoàn toàn có thể thêm vào URL những params khác, ví dụ như việc filter như sau :
http://localhost:3000/employees?first_name=Sebastian
Kết quả trả về là một object employee .
Deploy bằng địa chỉ IP
Việc deploy lên localhost như trên sẽ không thể sử dụng cho các trường hợp test từ bên ngoài ví dụ như mobile app, mà ta cần deploy nó với địa chỉ IP của máy.
Truy cập vào System Preferences / Network / Wifi, copy địa chỉ IP ( ví dụ x. x. x. x ) của máy và start json server với cú pháp sau :
$ json-server –host X.X.X.X data.json
Bây giờ, ta trọn vẹn hoàn toàn có thể truy vấn vào địa chỉ http://x.x.x.x:3000/employees từ bên ngoài để truy xuất thông tin .
Ngoài ra, để tìm hiểu sâu hơn về những hỗ trợ mà json server cung cấp, các bạn có thể tìm hiểu thêm ở đây https://github.com/typicode/json-server
