构建基于 Mongoose/MongoDB 的 API-JavaScript中文网-JavaScript教程资源分享门户

在前端开发过程中，API 是一个非常重要的概念。API 是指应用程序接口，简单说就是提供给其他程序调用的一组接口。而在后台开发中，Mongoose 和 MongoDB 是一种非常流行的数据库技术。本篇文章将介绍如何使用 Mongoose 和 MongoDB 来构建一个简单的 API，并提供示例代码。

准备工作

首先确保已经安装 MongoDB 和 Mongoose。然后新建一个项目，在项目根目录下新建一个名为 models 的文件夹，在此文件夹下新建一个名为 user.js 的文件。这个文件将用来定义用户的模型（模型即数据模板，用于定义存储在数据库中的数据的结构和属性）。

定义模型

首先让我们定义一个简单的用户模型，包括仅仅包括用户名和电子邮件地址：

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

const UserSchema = new Schema({
  name: String,
  email: String
});

module.exports = mongoose.model('User', UserSchema);

这个文件需要导出一个 User 模型，该模型由 Mongoose 的 model 方法创建。需要传递两个参数，“User” 是集合的名称，它将自动与数据库中的“users”集合关联。第二个参数是 UserSchema，它是用户数据的结构。

这里我们采用了 Schema 接口定义：

Schema 就是用来定义 MongoDB 中集合 Collection 里文档 document 的形式，可以理解为数据的一种类型定义。
Schema 可以看作是集合的模板，是集合 Collection 中文档文档document 结构的定义。
Mongoose 通过 Schema 来定义集合中文档document 的结构，可以理解为数据的一种类型定义。
需要将定义的 Schema 发布为 Model，Model 是操作集合中文档document 的接口，同时 Model 也可以理解为集合 collection 在代码层面的构造函数。

编写 API

接下来我们将编写一个 RESTful API，用于对用户进行操作。在项目根目录下新建一个名为 routes 的文件夹，在此文件夹下新建一个名为 users.js 的文件：

// www.javascriptcn.com code example
const express = require('express');
const mongoose = require('mongoose');
const User = require('../models/user');

const router = express.Router();

/* 获取所有用户 */
router.get('/', (req, res, next) => {
  User.find({}, (err, users) => {
    res.json(users);
  });
});

/* 创建一个新用户 */
router.post('/', (req, res, next) => {
  const user = new User({
    name: req.body.name,
    email: req.body.email
  });

  user.save((err) => {
    if (err) {
      return next(err);
    }
    res.json(user);
  });
});

/* 获取指定用户 */
router.get('/:userId', (req, res, next) => {
  User.findById(req.params.userId, (err, user) => {
    if (err) {
      return next(err);
    }
    res.json(user);
  });
});

/* 更新指定用户 */
router.put('/:userId', (req, res, next) => {
  User.findByIdAndUpdate(req.params.userId, {
    name: req.body.name,
    email: req.body.email
  }, { new: true }, (err, user) => {
    if (err) {
      return next(err);
    }
    res.json(user);
  });
});

/* 删除指定用户 */
router.delete('/:userId', (req, res, next) => {
  User.findByIdAndRemove(req.params.userId, (err, user) => {
    if (err) {
      return next(err);
    }
    res.json(user);
  });
});

module.exports = router;

以上代码使用了 express 模块来创建路由，具体说明如下：

GET /users 路由获取所有用户，使用 User.find 查询并通过 res.json 返回用户列表。
POST /users 路由创建一个新用户，最后使用 user.save 方法将新用户保存返回。
GET /users/:userId 路由获取指定用户，使用 User.findById 并通过 res.json 返回用户信息。
PUT /users/:userId 路由更新指定用户，使用 User.findByIdAndUpdate 更新用户信息并通过 res.json 返回更新后的用户。
DELETE /users/:userId 路由删除指定用户，使用 User.findByIdAndRemove 删除用户，并返回删除的用户。

这些操作都是通过 Mongoose 对数据库进行操作。每个路由都有特定的功能，可根据需要自由组合使用。

连接数据库

最后需要将应用程序连接到 MongoDB。在应用程序入口文件中，通常为 app.js 或 index.js，添加以下代码：

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

mongoose.connect('mongodb://localhost:27017/myapp', {
  useNewUrlParser: true,
  useUnifiedTopology: true,
  useFindAndModify: false
});

mongoose.connection.on('error', (err) => {
  console.log(err);
});

其中 mongoose.connect 方法使用了连接字符串和可选的参数。连接字符串表示要连接到的 MongoDB 实例的位置和名称，由主机名、端口号和数据库名组成。参数表示使用新的解析器、使用新的拓扑结构、禁用查找和修改等。

学习和指导意义

本篇文章介绍了如何使用 Mongoose 和 MongoDB 来构建一个基本的 API，并提供了示例代码。这里可以根据需要添加或更改路由结构，以实现所需功能。

在学习过程中，需要注意：

Mongoose 提供了非常多的 API 用于对数据库进行操作，不太熟悉的可以在官方文档上查阅。
使用数据模型架构，即 Schema，可以有效地规范数据的结构和格式，不易出错。
使用 RESTful 风格的 API 能够提高代码的复用性和开发效率。
MongoDB 是一种 NoSQL 数据库，具有比传统关系数据库更高的伸缩性和性能优势。

通过本篇文章的学习和实践，你可以更加深入地了解 Mongoose 和 MongoDB，掌握基本的数据操作方法，并为更复杂的项目做好准备。

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

构建基于 Mongoose/MongoDB 的 API

准备工作

定义模型

编写 API

连接数据库

学习和指导意义

接着读