Tất cả chúng ta đều sử dụng các phần mềm, web và ứng dụng di động khác nhau để làm cho cuộc sống của chúng ta trở nên dễ dàng. Chúng tôi duyệt internet mà không biết tác hại mà nó có thể gây ra cho chúng tôi và việc bạn có phải là nhà phát triển phần mềm hay không cũng không quan trọng. Hầu hết mọi ứng dụng phần mềm đều hoạt động trên mẫu API
API [Giao diện lập trình ứng dụng] là “một tập hợp các định nghĩa chương trình con, giao thức truyền thông và công cụ để xây dựng phần mềm. … API tốt giúp phát triển chương trình máy tính dễ dàng hơn bằng cách cung cấp tất cả các khối xây dựng, sau đó lập trình viên sẽ tập hợp chúng lại với nhau. ”
Hiểu REST trong Kỹ thuật phần mềm
REST là viết tắt của Chuyển giao trạng thái đại diện và nó được sử dụng để tìm nạp và quản lý dữ liệu bằng các dịch vụ không trạng thái khác nhau. Các hoạt động CRUD [Tạo, Đọc, Cập nhật, Xóa] là phần bên trong của giao thức HTTP và các hoạt động này cho phép chúng tôi thao tác dữ liệu trên máy chủ thông qua API RESTful
Các loại dịch vụ HTTP
Thuộc tínhChi tiếtPOSTTạo dữ liệu hoặc mục riêng lẻGETLấy một mục hoặc dữ liệu đơn lẻPUTCTạo hoặc thay thế dữ liệuPATCCHCập nhật dữ liệuDELETEXóa tài nguyênChúng tôi sẽ xây dựng API RESTful cho hệ thống quản lý trường học dựa trên mẫu hoạt động CRUD. Chúng tôi sẽ tạo các điểm cuối REST với Node, Express và MongoDB
Mục lục
Bước 1. Bắt đầu
Để làm việc với hướng dẫn này, bạn phải có Node. js trong hệ thống của bạn, hãy kiểm tra cách cài đặt Node JS trong hệ thống của bạn?
Sau đó, bạn phải cài đặt MongoDB trong hệ thống của mình, bạn có thể truy cập www. mongodb. trang web com để cài đặt mongoDB. Làm theo hướng dẫn này cài đặt MongoDB trên MacOS trong 5 phút
Bước 2. Nút. js Thiết lập dự án API RESTful
Đối với hướng dẫn này, tôi sẽ sử dụng MacOS và trình chỉnh sửa mã studio trực quan;
Trong bước đầu tiên, tạo một thư mục dự án, nơi sẽ giữ tất cả mã của chúng tôi. Nhập lệnh dưới đây vào terminal để tạo thư mục dự án và nhập vào đó
Tên dự án API Node JS REST.
npm init
6mkdir node-express-rest-api && cd node-express-rest-api
Chạy lệnh npm để khởi tạo project qua Node js, ngay khi nhập lệnh. Bạn sẽ được hỏi những câu hỏi sau cùng với điểm đầu vào mà chúng tôi đang sử dụng
npm init
7 nhưng bạn có thể đặt tên cho nó là bất cứ thứ gì bạn muốnnpm init
name: [node-express-rest-api]
version: [0.0.0]
description: A node rest api project.
entry point: [index.js]
test command:
git repository: [https://github.com/SinghDigamber/node-express-rest-api]
keywords:
author: Digamber Rawat [https://positronx.io]
license: [ISC]
Trong bước tiếp theo, chúng tôi sẽ cài đặt các mô-đun npm cần thiết để tạo API RESTful
npm install --save express mongoose cors body-parser
Tiếp theo, cài đặt mô-đun gật đầu. Nó sẽ giúp chúng tôi không phải khởi động lại máy chủ mỗi khi chúng tôi thực hiện các thay đổi trong dự án. Nó quan sát các thay đổi trong các tệp và mô-đun dự án và khởi động lại máy chủ ngay khi có bất kỳ thay đổi nào xảy ra
npm install nodemon --save-dev
Tập tin npm init
8 cuối cùng
________số 8_______npm init
Bước 3. MongoDB Thiết lập cho Hướng dẫn API REST
Trong bước này, chúng tôi sẽ giữ cài đặt cơ sở dữ liệu bằng Mongoose. Tạo một thư mục trong thư mục gốc của dự án của bạn và đặt tên là
npm init
9. Tạo một tệp theo tên của name: [node-express-rest-api]
version: [0.0.0]
description: A node rest api project.
entry point: [index.js]
test command:
git repository: [https://github.com/SinghDigamber/node-express-rest-api]
keywords:
author: Digamber Rawat [https://positronx.io]
license: [ISC]
0 trong thư mục db. Trong tệp này, chúng tôi sẽ giữ các cài đặt mongoDB, nó sẽ giúp chúng tôi tạo kết nối cơ sở dữ liệu trong ứng dụng ngăn xếp MEANNhập lệnh trong thiết bị đầu cuối
mkdir db
Vào bên trong thư mục
cd db
Tạo tệp
name: [node-express-rest-api]
version: [0.0.0]
description: A node rest api project.
entry point: [index.js]
test command:
git repository: [https://github.com/SinghDigamber/node-express-rest-api]
keywords:
author: Digamber Rawat [https://positronx.io]
license: [ISC]
0touch database.js
Chuyển đến tệp
name: [node-express-rest-api]
version: [0.0.0]
description: A node rest api project.
entry point: [index.js]
test command:
git repository: [https://github.com/SinghDigamber/node-express-rest-api]
keywords:
author: Digamber Rawat [https://positronx.io]
license: [ISC]
2 và thêm đoạn mã saumodule.exports = {
db: 'mongodb://localhost:27017/restapi'
}
Ở đây, mongoDB hoạt động cục bộ trên cổng 27017 và
name: [node-express-rest-api]
version: [0.0.0]
description: A node rest api project.
entry point: [index.js]
test command:
git repository: [https://github.com/SinghDigamber/node-express-rest-api]
keywords:
author: Digamber Rawat [https://positronx.io]
license: [ISC]
3 là tên cơ sở dữ liệuBước 4. Tạo mô-đun lược đồ sinh viên
Chúng tôi đã cài đặt Mongoose từ thư viện NPM để tạo kết nối mongoDB. Mongoose dựa trên mô hình dữ liệu đối tượng [ODM]. Nó giúp tạo mô hình dữ liệu bằng cách sử dụng mẫu lược đồ
Nhập lệnh để tạo cấu trúc thư mục cho mô-đun lược đồ sinh viên từ thư mục gốc của thư mục dự án của bạn
npm init
0Chuyển đến tệp
name: [node-express-rest-api]
version: [0.0.0]
description: A node rest api project.
entry point: [index.js]
test command:
git repository: [https://github.com/SinghDigamber/node-express-rest-api]
keywords:
author: Digamber Rawat [https://positronx.io]
license: [ISC]
4 và thêm đoạn mã saunpm init
1Bước 5. Xây dựng API RESTful với Express & Node JS
Tiếp theo, chúng tôi sẽ xây dựng API RESTful với Express js trong ứng dụng Node js. Đầu tiên, chúng ta sẽ tạo thư mục route và tạo một học sinh. tuyến đường. tập tin js trong đó
Chạy lệnh để tạo thư mục route và student. tuyến đường. tập tin js
npm init
2Sau đó, trong tệp
name: [node-express-rest-api]
version: [0.0.0]
description: A node rest api project.
entry point: [index.js]
test command:
git repository: [https://github.com/SinghDigamber/node-express-rest-api]
keywords:
author: Digamber Rawat [https://positronx.io]
license: [ISC]
5, chúng tôi sẽ nhập express js và mô hình lược đồ sinh viên. Chúng ta có thể sử dụng phương thức express js để xây dựng các API RESTful mạnh mẽ và an toàn, như được đề cập bên dướinpm init
3Bước 6. Cài đặt máy chủ ứng dụng nút
Đầu tiên, tạo một tệp
npm init
7 trong thư mục gốc của dự án của bạn. Trong tệp này, chúng tôi sẽ giữ cài đặt máy chủ của mình. Thêm mã dưới đây vào tệp js của máy chủnpm init
4Như bạn có thể thấy trong tệp trên, chúng tôi đã thực hiện các tác vụ sau
- Kết nối MongoDB
- Cài đặt JS nhanh
- Đã xác định gốc API REST
- CreateD PORT cho ứng dụng Node
- Thể hiện. xử lý lỗi tuyến đường js
- Thiết lập vị trí xây dựng qua express
Bây giờ, chúng tôi đã sản xuất thành công API RESTful của Node, Express và MongoDB với cấu trúc sau
- Tên
- dob [ngày sinh]
Bảng dưới đây bao gồm các API REST và các phương thức tương ứng của chúng
API MethodEndpointPOSTendpoint/create-studentGETendpoint/ [liệt kê sinh viên]GETendpoint/get-student/. id [lấy sinh viên từ danh sách sinh viên]PUTendpoint/update-student/. id [cập nhật dữ liệu sinh viên cụ thể]DELETEendpoint/remove-student/. id [xóa dữ liệu sinh viên cụ thể]Bước 7. Thử nghiệm Express JS REST API
Trong bước cuối cùng này, chúng tôi sẽ kiểm tra cục bộ các API RESTful của mình. Làm theo quy trình dưới đây để bắt đầu thử nghiệm
Thể hiện. js URL API REST. http. //máy chủ cục bộ. 8080/điểm cuối
Để kiểm tra API REST cục bộ, hãy chạy lệnh sau trong thiết bị đầu cuối
npm init
5Bước 8. Kiểm tra API RESTful của Node JS với Postman
Để kiểm tra API REST trong người đưa thư, bạn cần cài đặt Postman trong máy của mình. Bạn có thể truy cập tại đây để tải về công cụ kiểm tra Postman API
Khi bạn đã tải xuống xong Postman, hãy mở nó và chọn phương thức HTTP từ phần trên cùng bên trái. Sau đó, nhập API REST vào thanh tìm kiếm và nếu bạn nhận được phản hồi tương tự như trong ảnh chụp màn hình bên dưới, điều đó có nghĩa là API REST của chúng tôi đang hoạt động
Bạn cũng có thể kiểm tra các API REST khác của mình trong Postman, cuối cùng chúng ta đã hoàn thành việc tạo API RESTful an toàn với Node. js, MongoDB và Express JS từ đầu. Bạn có thể nhấp vào bên dưới để kiểm tra repo GitHub cho dự án này
Kho lưu trữ GitHub
máy đào
Tôi là Digamber, một nhà phát triển full-stack và là người đam mê thể dục. Tôi đã tạo trang web này để truyền kinh nghiệm mã hóa của mình cho các lập trình viên mới. Tôi thích viết trên JavaScript, ECMAScript, React, Angular, Vue, Laravel
Twitter GitHubBài viết đề xuất
Hướng dẫn về các loại lược đồ Mongoose, xác thực và truy vấnMongoDB Chèn tài liệu vào một bộ sưu tậpHướng dẫn cập nhật một tài liệu / nhiều tài liệu trong một bộ sưu tậpHướng dẫn về các loại dữ liệuMongoDB với các ví dụLàm thế nào để Gỡ cài đặt hoàn toàn MongoDB khỏi Linux?Hướng dẫn về MongoDB tạo một bộ sưu tập với ví dụMongoDB Xóa một hướng dẫn về bộ sưu tậpHướng dẫn bỏ một bộ sưu tậpMongoDB với