Giao diện MongoDB REST

Hãy xây dựng API REST tuân theo các nguyên tắc CRUD bằng Node, Express và MongoDB và kiểm tra nó bằng Postman

API là một thứ rất phổ biến hiện nay. Chúng được sử dụng ở mọi nơi trên trang web. API đóng vai trò là kết nối giữa cơ sở dữ liệu, nơi lưu trữ tất cả dữ liệu và giao diện người dùng mà người dùng tương tác để có quyền truy cập vào dữ liệu

API có nghĩa là Giao diện lập trình ứng dụng, là một tập hợp các phương thức giao tiếp được xác định rõ ràng giữa giao diện người dùng và cơ sở dữ liệu

REST viết tắt của Chuyển giao trạng thái đại diện là một kiểu kiến ​​trúc để cung cấp các tiêu chuẩn giữa các hệ thống máy tính trên web, giúp các hệ thống giao tiếp với nhau dễ dàng hơn

API REST chủ yếu sử dụng JSON làm lựa chọn ưu tiên để truyền dữ liệu vì chúng dễ hiểu và có thể đọc được

Trong hướng dẫn này, chúng tôi sẽ sử dụng Node, Express và MongoDB để tạo API REST hỗ trợ bốn thao tác - GET, POST, PUT và DELETE

Vì vậy, trước tiên hãy thảo luận về bốn thao tác này và cố gắng hiểu ý nghĩa của chúng trong bối cảnh phát triển API

1. GET — GET có nghĩa là đọc dữ liệu. Chức năng của thao tác này là lấy dữ liệu từ cơ sở dữ liệu và trình bày cho người dùng
2. POST — POST, như tên gợi ý, được sử dụng để đăng/thêm dữ liệu mới vào cơ sở dữ liệu. Nó cho phép người dùng thêm dữ liệu mới vào cơ sở dữ liệu
3. PUT - PUT có nghĩa là cập nhật dữ liệu đã có trong cơ sở dữ liệu
4. XÓA - Nó được sử dụng để xóa mọi dữ liệu hiện có khỏi cơ sở dữ liệu

Vì vậy, API REST của chúng tôi sẽ thực hiện tất cả bốn thao tác này. Chúng tôi sẽ sử dụng gói Express để làm cho công việc của chúng tôi dễ dàng hơn. Chúng tôi sẽ sử dụng MongoDB làm cơ sở dữ liệu NoSQL để lưu trữ tất cả dữ liệu của chúng tôi. MongoDB lưu trữ dữ liệu ở định dạng JSON

Vì vậy, chúng tôi sẽ làm điều đó từng bước. Đầu tiên, chúng tôi sẽ xây dựng các điểm cuối API và sau đó chúng tôi sẽ kết nối với cơ sở dữ liệu để thực hiện các hoạt động thực tế. Chúng tôi sẽ sử dụng phần mềm Postman để kiểm tra API

Thiết lập dự án

Trước hết, chúng ta cần tải xuống Node trên hệ thống của mình. Sau đó, chúng ta có thể bắt đầu tạo dự án của mình

Vì vậy, trước hết, chúng ta cần tạo một thư mục trong hệ thống của mình, nơi chúng ta muốn xây dựng dự án của mình. Tôi giữ tên thư mục là rest-API

Sau đó, chúng ta cần di chuyển vào thư mục rest-API mà chúng ta vừa tạo. Bây giờ để bắt đầu một dự án mới, chúng tôi sẽ chạy lệnh sau trong thư mục. -

npm init

Nó sẽ hỏi nhiều câu hỏi khác nhau liên quan đến dự án, như tên, mô tả và những thứ khác. Chúng tôi muốn giữ mọi thứ ở chế độ mặc định ngoại trừ tên và mô tả mà chúng tôi có thể thêm một cách thuận tiện

Sau khi hoàn thành, chúng ta sẽ thấy một gói. json trong thư mục. Nó chứa tất cả dữ liệu chúng tôi vừa cung cấp để tạo tệp này. Bạn có thể thấy điểm vào là chỉ số. tập tin js

Sau khi tạo gói. json, chúng tôi cần tải xuống Express trên máy của mình. Để cài đặt Express, chúng ta có thể. -

npm install express --save

Điều này sẽ tải xuống và lưu express trong hệ thống của chúng tôi và cũng sẽ thêm express dưới dạng phụ thuộc vào gói của chúng tôi. tập tin json

Chúng tôi cũng muốn tải xuống một phụ thuộc phát triển có tên là gật đầu, điều này sẽ cho phép chúng tôi phát triển nhanh hơn. Nó sẽ giúp chúng tôi tránh khởi động lại máy chủ mỗi khi chúng tôi thực hiện thay đổi và sẽ tự động làm mới, điều này sẽ giúp chúng tôi tiết kiệm rất nhiều thời gian

Vì vậy, để cài đặt gật đầu, chúng tôi sẽ làm

npm install --save-dev nodemon

Lưu ý rằng chúng tôi đã sử dụng save-dev để cài đặt và thêm nó vào gói. json dưới dạng phần phụ thuộc của nhà phát triển, vì chúng tôi đang sử dụng tệp này để tăng tốc quá trình phát triển của mình

Bây giờ, chúng tôi cần tải xuống MongoDB trong hệ thống của mình, sau đó tạo cụm và kết nối nó với máy tính cục bộ của bạn

Tiếp theo, chúng ta phải tải xuống cầy mangut để tương tác với cơ sở dữ liệu MongoDB từ ứng dụng cấp tốc của chúng ta

Để cài đặt cầy mangut, hãy làm như sau

npm install mongoose --save

Bây giờ, chúng tôi đã sẵn sàng để bắt đầu xây dựng API REST của mình. Trước khi bắt đầu, tôi muốn cho xem gói hàng của mình. json để bạn có thể xác minh mọi thứ đang diễn ra hoàn hảo

Vì vậy, hãy bắt đầu xây dựng API REST của chúng tôi. Trước hết, chúng ta cần tạo một tệp có tên là index. js;

tập tin chỉ mục

Chúng ta sẽ bắt đầu với chỉ số. tập tin js. Chúng tôi sẽ bắt đầu bằng cách yêu cầu chuyển phát nhanh vào hệ thống của chúng tôi

const express = require['express'];

Sau đó, chúng tôi sẽ thiết lập ứng dụng cấp tốc của mình bằng cách viết dòng mã sau. -

const app = express[];

Vì vậy, sau đó chúng tôi sẽ thiết lập chức năng GET để kiểm tra nó bằng trình duyệt. Chúng tôi chuyển một tin nhắn dưới dạng phản hồi khi chúng tôi có yêu cầu NHẬN tới localhost. 4000/API

app.get['/api', [req, res] => res.send['Its working!']];

Sau đó, chúng tôi sẽ thiết lập ứng dụng của mình để bắt đầu lắng nghe các yêu cầu. Chúng tôi sẽ sử dụng 4000 làm số cổng. Chúng tôi đã sử dụng toán tử OR ở đó để nếu có bất kỳ số cổng nào được xác định thông qua các biến môi trường, nó có thể sử dụng số đó; . Bạn có thể chọn số cổng theo sự lựa chọn của bạn. Chúng tôi sẽ an ủi. đăng nhập một tin nhắn để kiểm tra xem nó có hoạt động bình thường không

app.listen[process.env.port || 4000, function[]{
   console.log['now listening for requests'];
}];

Vì vậy, khi chúng tôi khởi động máy chủ ngay bây giờ bằng cách sử dụng

Khi chúng tôi truy cập localhost. 4000/api, chúng ta sẽ thấy thông báo 'Nó đang hoạt động. ’. Ngoài ra, trong bảng điều khiển, chúng tôi sẽ nhận được thông báo mà chúng tôi đã đặt cho bảng điều khiển

Vì vậy, chúng tôi ở đây, với máy chủ tốc hành được thiết lập đúng cách và chúng tôi đã gửi thành công yêu cầu GET đầu tiên của mình

Bây giờ, chúng tôi muốn có tất cả bốn thao tác trong một tệp riêng gọi là api. js trong thư mục routes, vì chúng tôi muốn tránh đẩy mọi thứ vào chỉ mục. tập tin js

Vì vậy, chúng tôi sẽ xóa ứng dụng. tham gia vào chỉ mục này. tập tin js. Chúng tôi muốn thêm cầy mangut như một yêu cầu trong tệp của chúng tôi

const mongoose = require['mongoose'];

Tiếp theo, bên dưới phần thiết lập ứng dụng cấp tốc của chúng tôi, chúng tôi muốn kết nối với MongoDB. Chúng tôi sẽ làm như vậy với đoạn mã sau

npm install express --save

Ở đây, ourdata là tên của mô hình mà chúng ta sẽ tạo trong MongoDb ở phần sau của hướng dẫn này

Chúng tôi cũng đã cập nhật lời hứa của cầy mangut thành lời hứa toàn cầu kể từ khi cầy mangut. lời hứa bây giờ bị khấu hao

Tiếp theo, chúng tôi sẽ thêm một vài phần mềm trung gian vào tệp. Trước tiên, chúng tôi sẽ thêm hỗ trợ để phục vụ các tệp tĩnh. Mặc dù chúng tôi sẽ không cung cấp các tệp tĩnh trong hướng dẫn này nhưng có nó cũng tốt vì chúng tôi sẽ cần thêm giao diện người dùng sau này để sử dụng API

npm install express --save

Sau đó, chúng tôi sẽ thêm trình phân tích cú pháp Express để phân tích cú pháp dữ liệu được gửi hoặc nhận từ cơ sở dữ liệu

npm install express --save

Sau đó, chúng tôi thiết lập ứng dụng để sử dụng api mới. js mà chúng ta sẽ tạo để chứa cả bốn thao tác

npm install express --save

Chúng tôi đã thêm '/api' ngay từ đầu để tránh thêm nó vào cả bốn thao tác

Cuối cùng, chúng tôi đã thêm một phần mềm trung gian để xử lý các lỗi xảy ra trong quá trình hoạt động

npm install express --save

Đây là mã hoàn thiện cho chỉ mục. tập tin js. -

Bố cục của bốn hoạt động CRUD

Tiếp theo, chúng tôi tạo một thư mục có tên là bộ định tuyến và tạo một tệp mới có tên là api. js bên trong thư mục. Điều này sẽ chứa tất cả bốn thao tác CRUD mà chúng tôi muốn thực hiện với API REST mà chúng tôi đang xây dựng

Trước tiên, chúng tôi bắt đầu bằng cách yêu cầu chuyển phát nhanh trong tệp của mình. Sau đó, chúng tôi sẽ tạo một bộ định tuyến bằng bộ định tuyến tốc hành

npm install express --save

Vì vậy, hãy bắt đầu xây dựng từng thao tác một. Chúng tôi sẽ không lưu bất cứ thứ gì vào cơ sở dữ liệu vì chúng tôi chưa tạo cơ sở dữ liệu, nhưng chúng tôi sẽ kiểm tra chúng đơn giản hơn

Vì vậy, chúng ta sẽ bắt đầu với toán tử GET. Chúng tôi sẽ viết mã cho yêu cầu GET theo cách này. -

npm install express --save

Ở đây, chúng tôi đang đưa ra điểm cuối và một chức năng đưa ra phản hồi cho biết loại yêu cầu được gửi

Tiếp theo là yêu cầu POST. Nó sẽ theo cách tương tự mặc dù chúng tôi muốn trả lại dữ liệu mà chúng tôi đã nhận được từ yêu cầu

npm install express --save

Tiếp theo là yêu cầu PUT và DELETE. Hiện tại, chúng tôi sẽ trả về loại yêu cầu cho cả hai hoạt động. Nó chấp nhận điểm cuối với id biểu thị id duy nhất mà MongoDB cung cấp khi chúng tôi lưu dữ liệu vào đó

npm install express --save

Tiếp theo, chúng tôi sẽ xuất mô-đun sẽ được sử dụng trong chỉ mục. tập tin js

npm install express --save

Để kiểm tra các hoạt động này, chúng tôi sẽ sử dụng một phần mềm có tên Postman. Thật tuyệt vời và giúp kiểm tra API rất nhanh

Tải xuống tác nhân máy tính để bàn Postman hoặc cài đặt tiện ích mở rộng Chrome của nó để bắt đầu sử dụng Postman. Một Workspace mới của Postman trông như sau. -

Tại đây, chúng ta có thể chọn loại hoạt động và URL đích để gửi yêu cầu. Đối với các yêu cầu POST, chúng tôi cần gửi một số dữ liệu JSON trong khi gửi yêu cầu mà chúng tôi có thể thực hiện bằng cách thêm JSON vào phần Nội dung

Bạn cần chọn kiểu dữ liệu Raw rồi chọn JSON làm định dạng như hình bên dưới. -

Vì vậy, chúng tôi có thể kiểm tra tất cả các hoạt động này thông qua Postman rất dễ dàng. Chúng tôi cũng cần cung cấp dữ liệu trong khi yêu cầu PUT khi chúng tôi đang cập nhật dữ liệu. Chúng tôi chỉ chuyển dữ liệu chúng tôi cần cập nhật

Xây dựng lược đồ và mô hình cơ sở dữ liệu

Tiếp theo, chúng ta sẽ tạo một thư mục có tên models và sau đó tạo một học sinh. js trong thư mục đó

Chúng tôi sẽ yêu cầu cầy mangut trong thư mục đó và sẽ xây dựng một Lược đồ và sau đó là một mô hình dựa trên Lược đồ đó. Lược đồ cho mô hình biết dữ liệu được cấu trúc như thế nào

Chúng tôi đang xây dựng một mô hình chứa dữ liệu của các sinh viên - tên, số điểm danh của họ và liệu họ có mặt hay không

1. Tên — Đây là kiểu dữ liệu Chuỗi và không phải là trường bắt buộc trong Lược đồ
2. Cuộn — Đây cũng là kiểu dữ liệu Chuỗi và là trường bắt buộc. Nó không thể để trống
3. Hiện tại - Đây là trường Boolean mặc định là true

Sau đó, chúng tôi đã tạo mô hình có tên là Sinh viên với sự trợ giúp của StudentSchema mà chúng tôi đã tạo. Sau đó, chúng tôi xuất mô hình để sử dụng nó trong tệp API

Vì vậy, chúng ta hãy nhìn vào học sinh. tập tin js. -

Hoàn thiện api. tập tin js

Bây giờ, chúng tôi sẽ làm cho tất cả bốn điểm cuối API có thể sử dụng được bằng cách lưu và truy xuất dữ liệu từ mô hình cơ sở dữ liệu mà chúng tôi đã tạo

Vì vậy, chúng ta cần yêu cầu mô hình cơ sở dữ liệu đó trong tệp API

npm install --save-dev nodemon

Sau đó, chúng tôi bắt đầu với yêu cầu GET. Chúng tôi sẽ nhận được tất cả các sinh viên trong cơ sở dữ liệu của chúng tôi và gửi tất cả chúng dưới dạng phản hồi. Bạn có thể thêm bất kỳ loại bộ lọc nào cho sinh viên, nhưng chúng tôi sẽ để trống chức năng tìm kiếm để truy cập mọi sinh viên từ cơ sở dữ liệu. Sau đó chúng tôi sử dụng. hàm catch[next] để giúp bắt bất kỳ lỗi nào và chuyển nó sang phần mềm trung gian tiếp theo — phần mềm trung gian xử lý lỗi trong trường hợp của chúng tôi

npm install --save-dev nodemon

Tiếp theo, chúng tôi thực hiện yêu cầu POST. Chúng tôi tạo một sinh viên mới trong cơ sở dữ liệu và sau đó trả về sinh viên đã tạo dưới dạng phản hồi

npm install --save-dev nodemon

Tiếp theo, chúng tôi có yêu cầu PUT. Chúng tôi sẽ sử dụng hàm findOneAndUpdate để tìm mục nhập tương ứng trong cơ sở dữ liệu bằng cách sử dụng id mà chúng tôi đã chuyển vào điểm cuối URL. Sau đó, chúng tôi tìm cùng một sinh viên với sự trợ giúp của Id của họ và trả lại sinh viên đã cập nhật dưới dạng phản hồi

npm install --save-dev nodemon

Cuối cùng, chúng tôi có yêu cầu DELETE. Ta sử dụng hàm findOneAndDelete để tìm sinh viên tương ứng trong cơ sở dữ liệu thông qua id được cung cấp và xóa sinh viên đó khỏi cơ sở dữ liệu. Nó cũng trả về sinh viên đã xóa như một phản hồi

npm install --save-dev nodemon

Chúng ta có thể kiểm tra tất cả những thứ này bằng phần mềm Postman rất dễ dàng. Mọi thứ sẽ hoạt động tốt khi thử nghiệm và chúng tôi đã làm mọi thứ tốt đẹp và rõ ràng

Đây là mã cuối cùng cho api. tập tin js. -

Vì vậy, cuối cùng, chúng tôi đã tạo API REST của mình, API này thực hiện cả bốn thao tác CRUD. Vì vậy, như bạn thấy, rất dễ dàng để xây dựng API REST với sự trợ giúp của Node, Express và MongoDB

MongoDB có API REST không?

Làm cách nào để lưu trữ phản hồi API trong MongoDB?

MongoDB có thể được lưu trữ cục bộ không?

Làm cách nào để tìm nạp dữ liệu từ API trong MongoDB?