Hướng dẫn api key nodejs - khóa api nodejs
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 việc với ngôn ngữ Nodejs hoặc đơn giản là muốn tạo một RESTful API với NodeJS Show REST là gì?Đầu tiên thì các bạn cần hiểu rõ khái niệm về REST và RESTful là gì phải không? REST là từ viết tắt của Representational State Transfer. Đó 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 bốn hoạt động được gọi là CRUD (C: Create, R: Read, U: Update, và D: Delete). Để 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 một RESTful API bằng cách sử dụng Node.js. Công cụ:
Bắt đầu** Giả định**: Máy bạn đã cài đặt NodeJS và MySQL
package.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 phụ thuộc của dự án. 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 file package.json với nội dung như thế này:
Cuối cùng thì project sẽ có cấu trúc như thế này: Cài đặt server
Khi cài đặt thành công, tệp package.json của bạn sẽ được sửa đổi để có 4 gói mới được cài đặt. Mở file package.json và thêm script này vào mục scripts: 7Như vậy file package.json đã được thay đổi thành:
Tạo database
Và đây là bảng sau khi chạy sql: Tạo file kết nối DatabaseTrước tiên mình cần đưa các config cho database ra file .env Đây là file 9 với nội dung:
** Lưu ý: ** Các bạn có thể tạo file .env.example để đưa lên git và đưa file .env vào .gitignore Tiếp đến mình sẽ tạo file db.js: 0Như vậy là xong phần config db, khi sử dụng bạn chỉ cần require file db.js vào là có 1 đối tượng db để truy vấn db rồi. Tạo routesDưới đây mình đã tạo hai router cơ bản ( 0, và 1) với các phương thức
Và đây là nội dung file routes.js: 1Tiếp đến mình sẽ tạo file controller và các function tương ứng cho từng routes Tạo file controllerTrong file ProductsController.js, mình sẽ tạo 5 function có tên: get, detai, update, store, delete và export 5 hàm này để sử dụng trong routes.js. 2Ở đây mình dùng package mysql, để tìm hiểu cách sử dụng chi tiết của package này bạn có thể truy cập vào: Sắp xếp lại nội dung file server.jsBên trên, mình đã có một đoạn code ngắn chỉ với mục đích tạo 1 server, sau khi tạo routes, controllers hoàn chỉnh mình sẽ sửa lại file server.js để có thể chạy được app hoàn chỉnh: Dưới đây là file server.js: 3Mình đã cập nhật thêm
Kế tiếp để chạy lại server các bạn chạy lệnh: 4Và console sẽ hiển thị:
Thực hiện test API trên Postman
6
7
8
9
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 sửa nhé ) )Các bạn có thể tham khảo repo github của mình ở đâ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ẻ, bạn có thể tặng mình 1 cốc coffe nha ^^. Tặng liền! Cảm ơn bạn rất nhiều! Thanks for reading! |