Tài liệu api phần còn lại mongodb

Khi chúng tôi xây dựng ứng dụng Web hoặc các ứng dụng phía máy chủ, việc tạo RESTful API để tương tác với máy khách trở nên vô cùng phổ biến

Ở bài viết này, mình sẽ tạo RESTful API để hỗ trợ đủ 4 thao tác. CRUD (Tạo – Đọc – Cập nhật – Xóa)

Trước khi chúng ta vào bài viết, bạn nên chuẩn bị sẵn những yêu cầu sau

• Hiểu về RESTful APIs
• Cài đặt nút. JS
• Cài đặt MongoDB

OK, sau khi môi trường lập trình đã sẵn sàng, chúng ta bắt tay vào việc tạo RESTful API thôi

Nội dung chính của bài viết

• #Tạo API RESTful
• #Cấu hình nút. js với Express framework
  • #Tương tác với MongoDB sử dụng Mongoose
• #Tạo RESTful API và xử lý hành động logic
  • #Tổng kết

tạo RESTful API là một kiểu thiết kế ứng dụng trong đó quy định định dạng của địa chỉ URL và phương thức HTTP sử dụng để quản lý tài nguyên trên máy chủ

Tài nguyên trên Server trong bài viết này mình giả sử là danh sách người trong Database

Việc thiết kế REST cũng khá đơn giản, chúng ta sẽ định nghĩa 4 hàm xử lý 4 hành động

• Tạo tài nguyên mới (ví dụ thêm một người)
• Chỉnh sửa tài nguyên có sẵn (ví dụ: cập nhật thông tin của một người)
• Get the data of resource (xem thông tin của một người/hoặc nhiều người)
• Xoá tài nguyên (Xóa thông tin của một người)

Cụ thể trong bài viết này thì mình sẽ thiết kế như sau

#Cấu hình nút. js với Express framework

Để bắt đầu, chúng ta sẽ tạo một dự án mới với các phụ thuộc cần thiết. Từ cửa sổ lệnh, chúng ta thực hiện các lệnh sau

npm init -y
npm install express body-parser mongoose --save

Kết thúc các lệnh trên, chúng ta sẽ tạo một gói. json, và cài đặt ExpressJS, Mongoose và một gói hỗ trợ chuyển dữ liệu theo cách yêu cầu từ máy khách thành dữ liệu JSON

Để đơn giản, mình sẽ chọn tất cả mã nguồn vào một ứng dụng tệp. js. Tuy nhiên, điều này không được triển khai theo dự án thực tế nhé. Với dự án thực tế, các bạn nên áp dụng các quy tắc như nguyên lý RẮN để đảm bảo dự án sạch sẽ, dễ bảo trì

Bạn đã tạo tệp ứng dụng. js tại thư mục gốc của dự án

/**
 * Son Duong
 * https://vntalking.com
 * June 14, 2019
 */
const Express = require("express");
const Mongoose = require("mongoose");
const BodyParser = require("body-parser");

var app = Express();

app.use(BodyParser.json());
app.use(BodyParser.urlencoded({ extended: true }));

// Define REST API
app.post("/person", async (request, response) => {});
app.get("/people", async (request, response) => {});
app.get("/person/:id", async (request, response) => {});
app.put("/person/:id", async (request, response) => {});
app.delete("/person/:id", async (request, response) => {});

app.listen(3000, () => {
    console.log("Listening at :3000...");
});

Mình sẽ giải thích một chút về đoạn code trên. Đầu tiên, chúng ta cần yêu cầu những mô-đun cần thiết như. express, mongoose và body-parser

Tiếp theo, chúng ta sẽ định nghĩa API là thiết kế mục 2 ở trên bài viết. Chúng ta sẽ bổ sung logic xử lý cho từng hàm sau

Cuối cùng, chúng ta khai báo ứng dụng sẽ lắng nghe cổng 3000

#Tương tác với MongoDB sử dụng Mongoose

Để có thể kết nối được với MongoDB, bạn cần khai báo đúng đường dẫn

Mongoose.connect("mongodb://localhost/vntalking");

Trong đó vtalking là tên cơ sở dữ liệu (tương đương với tên cơ sở dữ liệu trong SQL vậy)

Lưu ý. Bài viết này mình tập trung vào các logic tương tác với MongoDB từ Nodejs. Do đó, mặc định mình sẽ xem các bạn đã biết cách tạo bộ sưu tập trong MongoDB. Nếu bạn muốn quản lý MongoDB một cách dễ dàng thì có thể sử dụng công cụ Robo3T

Sau khi cấu hình kết nối xong, mình sẽ tiến hành tạo mô hình. Trong khuôn khổ ví dụ của bài viết này, chúng ta chỉ cần tạo ra một mô hình như sau

const PersonModel = Mongoose.model("person", {
    firstname: String,
    lastname: String
});

Mô hình này sẽ tạo một bộ sưu tập người (tương đương với việc tạo một bảng trong SQL vậy). With each document will have 2 information. tên và họ

Ok, như vậy phần cấu hình với MongoDB đã hoàn tất, chúng ta tiến hành xử lý logic cho mỗi API

#Tạo RESTful API và xử lý hành động logic

Đầu tiên, chúng ta sẽ viết mã xử lý phần tạo mới cho một người

app.post("/person", async (request, response) => {
    try {
        var person = new PersonModel(request.body);
        var result = await person.save();
        response.send(result);
    } catch (error) {
        response.status(500).send(error);
    }
});

Khi máy khách thực hiện một yêu cầu POST tới ứng dụng của chúng tôi. Chúng ta sẽ sử dụng PersonModel và JSON payload để lưu thông tin vào cơ sở dữ liệu

Có một điểm lưu ý, tất cả những công việc tương tác với cơ sở dữ liệu đều có thể kích hoạt thời gian và bạn cần phải sử dụng cơ chế xử lý bất đồng bộ. Trước kia bạn có thể sử dụng Promise, và giờ thì hiện đại hơn, sử dụng kỹ thuật mới async và await (Hỗ trợ từ javascript ES7)

Sau khi lưu dữ liệu thành công, chúng tôi sẽ trả lại kết quả cho khách hàng biết

Tiếp theo, khi đã có dữ liệu, chúng ta có thể lấy dữ liệu từ cơ sở dữ liệu

app.get("/people", async (request, response) => {
    try {
        var result = await PersonModel.find().exec();
        response.send(result);
    } catch (error) {
        response.status(500).send(error);
    }
});

Có hai kiểu dữ liệu. Một là lấy toàn bộ danh sách người có trong cơ sở dữ liệu, hai là lấy thông tin cụ thể của một người nào đó

Trong API kịch bản này, khi khách hàng không gửi bất kỳ điều kiện kỳ ​​lạ nào, thì sẽ trả về một danh sách những người

Nếu khách hàng gửi cụ thể ID của một người nào đó, họ sẽ chỉ trả lại cho 1 người mà thôi. Thực hiện như sau

app.get("/person/:id", async (request, response) => {
    try {
        var person = await PersonModel.findById(request.params.id).exec();
        response.send(person);
    } catch (error) {
        response.status(500).send(error);
    }
});

Khi client gửi ID của người đó lên, chúng ta sẽ sử dụng hàm findById() để tìm kiếm trong cơ sở dữ liệu xem có người nào tương ứng với ID đó không. Nếu tồn tại người đó thì trả lại cho khách hàng

Hoàn toàn tương tự với việc cập nhật và xóa thông tin của một người khi biết ID

app.put("/person/:id", async (request, response) => {
    try {
        var person = await PersonModel.findById(request.params.id).exec();
        person.set(request.body);
        var result = await person.save();
        response.send(result);
    } catch (error) {
        response.status(500).send(error);
    }
});

app.delete("/person/:id", async (request, response) => {
    try {
        var result = await PersonModel.deleteOne({ _id: request.params.id }).exec();
        response.send(result);
    } catch (error) {
        response.status(500).send(error);
    }
});

Như vậy là chúng ta đã hoàn thành đủ 4 hành động như thiết kế ban đầu. Các bạn có thể kiểm tra ứng dụng bằng cách sử dụng Postman. Tất nhiên, đừng quên chạy ứng dụng trước khi kiểm tra trên máy chủ bằng lệnh sau

#Tổng kết

Qua bài viết, chúng ta đã biết cách tạo RESTful API đơn giản rồi phải không?

Trong bài viết này, mình đang sử dụng một framework để tạo API dễ dàng hơn, nếu có hứng thú, bạn có thể đọc thêm về ExpressJS framework này tại đây

• Xây dựng trang web dễ dàng với ExpressJS

Phần tiếp theo, mình sẽ cùng nhau tìm hiểu về những kỹ thuật khác của NodeJs như Promise, Event và Filestream