Xin chào mọi người, hôm nay mình muốn demo cho những bạn chưa từng làm với ngôn ngữ Nodejs hoặc đơn giản là muốn tạo một RESTful API với NodeJS
Nội dung chính Hiển thị
REST là gì?
Đầu tiên thì các bạn cần hiểu khái niệm về REST và RESTful là gì phải không?
REST là từ viết tắt của Chuyển trạng thái đại diện. Đó là kiến trúc tiêu chuẩn web và Giao thức HTTP
Hiểu đơn giản thì các ứng dụng RESTful sử dụng các yêu cầu HTTP để thực hiện các hoạt động được gọi là CRUD [C. Tạo, R. Đọc, U. Cập nhật, và D. Xóa bỏ]
Để hiểu rõ hơn về khái niệm RESTful các bạn có thể tham khảo bài viết này nhé. Tìm hiểu về RESTful web services
Trong hướng dẫn này, chúng ta sẽ tìm hiểu cách tạo RESTful API bằng cách sử dụng Node. js
tool
- Nút. js v7
- mysql
- Trình soạn thảo văn bản hoặc IDE
- Người phát thơ
Start
** Giả định**. Máy bạn đã cài đặt NodeJS và MySQL
- Đầu tiên bạn vào dự án tạo một gói tệp. json -
1npm install express --save
bưu kiện. json là một tệp cung cấp thông tin cần thiết cho npm, cho phép nó xác định dự án cũng như xử lý các thành viên phụ thuộc của dự án.
npm install express --save
1 sẽ nhắc bạn nhập một số thông tin như tên ứng dụng, mô tả, phiên bản, tác giả, từ khóa,. Khi tạo xong các bạn sẽ có 1 gói tệp. json với nội dung như thế này{
"name": "nodejs_api",
"version": "1.0.0",
"description": "",
"main": "app.js",
"scripts": {
"test": "echo \"Error: no test specified\" && exit 1"
},
"author": "",
"license": "ISC"
}
Tạo máy chủ tập tin. js ở thư mục gốc. Trong tệp này, mình sẽ viết các giao thức để tạo một ứng dụng mới
Tạo một thư mục có tên là api Bên trong thư mục này, mình tạo ra các bộ điều khiển thư mục để chứa các bộ điều khiển tệp, các tuyến tệp. js để quản lý các API liên kết và tệp db. js to connect database
Create ProductsController. js trong thư mục api/controllers
Cuối cùng thì dự án sẽ có cấu trúc như thế này
Cài đặt máy chủ
- Ở đây mình dùng gói 4 rất hay dùng đó là
3 sẽ được sử dụng để tạo máy chủnpm install express --save
4 sẽ giúp mình theo dõi các thay đổi đối với ứng dụng của mình bằng cách xem các tệp đã thay đổi và tự động khởi động lại máy chủnpm install express --save
5 to mình thêm các config cho database[host, port, user, pass,. ] and other confignpm install express --save
6 to thao tác với cơ sở dữ liệunpm install express --save
npm install --save-dev nodemon
npm install express --save
npm install dotenv --save
npm install express --save
0Khi cài đặt thành công, gói tệp. json của bạn sẽ được sửa đổi để có 4 gói mới được cài đặt
Open file package. json và thêm tập lệnh này vào mục tập lệnh.
npm install express --save
7gói tập tin như vậy. json has been instead to
npm install express --save
2- Open file server. js và nhập / sao chép mã bên dưới vào tệp
npm install express --save
3- Trên thiết bị đầu cuối của bạn, tiếp tục chạy
8 để khởi động máy chủ và sau đó bạn sẽ thấynpm install express --save
npm install express --save
5Tạo cơ sở dữ liệu
npm install express --save
6Và đây là bảng sau khi chạy sql
Create file connection Database
Trước tiên mình cần đưa cấu hình cho tệp cơ sở dữ liệu. env This is file
npm install express --save
9 with contentnpm install express --save
8** Lưu ý. ** Các bạn có thể tạo tệp. env. ví dụ để đưa lên git và gửi tệp. env vào. gitignore
Tiếp theo mình sẽ tạo file db. js
npm install --save-dev nodemon
0Như vậy là xong phần cấu hình db, khi sử dụng bạn chỉ cần yêu cầu tệp db. js vào là có 1 đối tượng db để truy vấn db rồi
Tạo tuyến đường
Dưới đây mình đã tạo hai bộ định tuyến cơ bản [
npm install dotenv --save
0, và npm install dotenv --save
1] với các phương thức
0 has the method [______93 andnpm install dotenv --save
4]npm install dotenv --save
1 có 3 phương thứcnpm install dotenv --save
3 ,npm install dotenv --save
7 vànpm install dotenv --save
8. Như bạn có thể thấy, mình đã tạo ra 2 bộ định tuyến và các phương thức để gọi các hàm xử lý tương thíchnpm install dotenv --save
Và đây là các tuyến tệp nội dung. js
npm install --save-dev nodemon
1Tiếp theo mình sẽ tạo file controller và các chức năng tương ứng với từng route
Tạo bộ điều khiển tập tin
Trong tệp ProductsController. js, mình sẽ tạo 5 hàm có tên. get, detai, update, store, delete and export 5 hàm này để sử dụng trong các route. js
npm install --save-dev nodemon
2Ở đây mình sử dụng gói mysql, để tìm hiểu cách sử dụng chi tiết của gói này mà bạn có thể truy cập vào
Sắp xếp lại máy chủ tệp nội dung. js
Bên trên, mình đã có đoạn code rút ngắn chỉ với mục đích tạo 1 server, sau khi tạo route, controllers mình sẽ edit lại file server. js để có thể chạy ứng dụng đã hoàn chỉnh
Dưới đây là máy chủ tập tin. js
npm install --save-dev nodemon
3Mình đã cập nhật thêm
9 để trích xuất toàn bộ phần nội dung của yêu cầu đến và hiển thị nó trên đónpm install dotenv --save
00npm install express --save
- load dotenv để sử dụng các biến môi trường
- nhập file routes để tải tất cả các route đã được khai báo trong file
- thêm phần mềm trung gian để kiểm tra xem API yêu cầu không tồn tại Dễ hiểu phải không??
Kế hoạch tiếp theo để chạy lại máy chủ mà bạn đã chạy lệnh
npm install --save-dev nodemon
4And console will display
npm install express --save
5Thực hiện test API trên Postman
- Nhận tất cả [phương thức GET].
01npm install express --save
npm install --save-dev nodemon
6- Nhận với id [phương thức GET].
02npm install express --save
npm install --save-dev nodemon
7- Tạo [phương thức POST].
01npm install express --save
npm install --save-dev nodemon
8- Cập nhật [phương thức PUT].
04npm install express --save
npm install --save-dev nodemon
9- Xóa [phương thức XÓA].
04npm install express --save
npm install express --save
0OK, như vậy mình đã hướng dẫn xong cách xây dựng 1 RESTful API đơn giản với ngôn ngữ NodeJS, bài viết dựa trên kinh nghiệm của bản thân, nếu có gì sai sót mong các bạn comment để mình chỉnh sửa nhé
]Các bạn có thể tham khảo repo github của mình tại đây nhé. https. //github. com/tienphat/api_nodejs_example
Nếu các bạn yêu thích bài viết và nội dung mình chia sẻ thì có thể tặng mình 1 cốc cà phê nha ^^. liền kề. Cảm ơn bạn rất nhiều