如何使用 MongoDB 和 Node.js 搭建 RESTful API

概述

在前端开发中，使用 RESTful API 是非常普遍的。但是，如何搭建一个高效的 RESTful API 呢？本文将介绍如何使用 MongoDB 和 Node.js 搭建一个高效的 RESTful API，并提供具体的指导和示例代码。

MongoDB 和 Node.js 简介

1. MongoDB 是一种基于文档的 NoSQL 数据库，其优点包括可扩展性好、能够存储大量数据、灵活性高等特点。
2. Node.js 是一种基于 JavaScript 的可扩展、高效、为事件而生的 Web 服务器。

这两者的结合将会是一个非常合适的选择。

创建 RESTful API

在创建 RESTful API 之前，首先要明确如下几点:

1. 建立服务器：需要建立一个 Node.js 的服务器。
2. 定义 RESTful API：要定义所需的 API 端点。
3. 连接 MongoDB：需要使用 MongoDB 驱动程序来连接到 MongoDB 数据库。

建立服务器

首先需要安装 Node.js 和 MongoDB，并使用 Node.js 的包管理器（npm）安装以下工具：

• express：用来构建 Node.js 服务器。
• body-parser：用来解析 HTTP 请求正文。
• mongoose：用来连接 MongoDB 数据库并执行操作。

下面是示例代码：

// www.javascriptcn.com code example
const express = require('express');
const bodyParser = require('body-parser');
const mongoose = require('mongoose');

const app = express();
app.use(bodyParser.json());

mongoose.connect('mongodb://localhost:27017/myapp', { useNewUrlParser: true });
mongoose.Promise = global.Promise;

定义 RESTful API

RESTful API 的定义需要遵循以下约定：

• 所有资源的 URL 都应该是相同的格式，并使用 HTTP 动词进行操作。
• 所有与资源相关的行为都应该由 HTTP 动词表示：
  • GET：获取资源或资源集合。
  • POST：创建新资源。
  • PUT：更改资源。
  • DELETE：删除资源。
• 所有资源都应该是唯一标识的，并使用 ID 进行标识。

下面是示例代码：

// www.javascriptcn.com code example
const express = require('express');
const router = express.Router();

const Movie = require('../models/movie');

router.get('/movies', (req, res) => {
  Movie.find().then((movies) => {
    res.send(movies);
  }).catch((err) => {
    res.status(404).send(err);
  });
});

router.get('/movies/:id', (req, res) => {
  Movie.findById(req.params.id).then((movie) => {
    if (movie) {
      res.send(movie);
    } else {
      res.status(404).send(`Movie:${req.params.id} not found...`)
    }
  }).catch((err) => {
    res.status(404).send(err);
  });
});

router.post('/movies', (req, res, next) => {
  new Movie(req.body).save((err, movie) => {
    if (err) {
      next(err);
    } else {
      res.status(201).send(movie);
    }
  });
});

router.patch('/movies/:id', (req, res) => {
  Movie.findByIdAndUpdate(req.params.id, { $set: req.body }, { new: true }).then((updatedMovie) => {
    if (updatedMovie) {
      res.send(updatedMovie);
    } else {
      res.status(404).send(`Movie:${req.params.id} not found...`);
    }
  }).catch((err) => {
    res.status(404).send(err);
  });
});

router.delete('/movies/:id', (req, res) => {
  Movie.findByIdAndRemove(req.params.id).then((movie) => {
    if (movie) {
      res.send(movie);
    } else {
      res.status(404).send(`Movie:${req.params.id} not found...`);
    }
  }).catch((err) => {
    res.status(404).send(err);
  });
});

module.exports = router;

连接 MongoDB

连接到 MongoDB 数据库需要使用 mongoose，这样就可以执行各种操作，包括查询、添加、修改和删除数据。

下面是示例代码：

// www.javascriptcn.com code example
const mongoose = require('mongoose');

const Schema = mongoose.Schema;
const MovieSchema = new Schema({
  title: {
    type: String,
    required: true,
  },
  director: {
    type: String,
    required: true,
  },
  year: {
    type: Number,
    required: true,
  },
});

const Movie = mongoose.model('movie', MovieSchema);

module.exports = Movie;

测试 RESTful API

最后，可以使用测试工具（如 Postman）测试所有 API 端点是否正常工作。

到此为止，介绍了如何使用 MongoDB 和 Node.js 搭建一个高效的 RESTful API，并提供了具体的指导和示例代码。通过这些知识的学习，可以更好地理解 RESTful API，并在实际应用中更加游刃有余。

来源：JavaScript中文网 ，转载请注明来源 https://www.javascriptcn.com/post/67d6d04aa941bf7134caf320