用 Node.js 搭建 RESTful API 的完整教程-JavaScript中文网-JavaScript教程资源分享门户

在现代的 Web 应用中，RESTful API 已经成为了常见的数据交互方式。Node.js 作为一种高效、轻量级的 JavaScript 运行环境，被广泛用于搭建 RESTful API。本文将介绍如何用 Node.js 搭建 RESTful API，包括路由、控制器、数据存储等方面的内容。

什么是 RESTful API？

RESTful API（Representational State Transfer）是一种基于 HTTP 协议的 Web API 设计风格。它使用 HTTP 动词（GET、POST、PUT、DELETE 等）对资源进行操作，并通过 URL 表示资源的状态。RESTful API 主要的特点包括以下几点：

客户端-服务器结构
无状态（即每个请求都是独立的）
可缓存
分层系统
统一接口

搭建 RESTful API 的步骤

步骤一：安装 Node.js

在开始之前，需要先安装 Node.js。可以从 Node.js 的官方网站上下载安装包并安装。

步骤二：初始化项目

打开命令行工具，进入项目所在目录，执行以下命令来初始化项目：

npm init

这个命令会创建一个 package.json 文件，用于管理项目的依赖和脚本等信息。

步骤三：安装依赖

接下来，需要安装项目所需的依赖。在命令行中执行以下命令来安装 Express 和其他依赖：

npm install express body-parser mongoose --save

其中，Express 是一个 Web 框架，用于处理 HTTP 请求和响应；body-parser 是一个中间件，用于解析请求体中的数据；mongoose 是一个 MongoDB 的对象模型工具，用于连接和操作 MongoDB 数据库。

步骤四：创建路由

在 Express 中，路由是用于处理 HTTP 请求的模块。可以在项目根目录下创建一个 routes 目录，用于存放路由模块。在 routes 目录中创建一个名为 index.js 的文件，用于定义路由。

// javascriptcn.com 代码示例
const express = require('express');
const router = express.Router();

// 定义路由
router.get('/', (req, res) => {
  res.send('Hello World!');
});

module.exports = router;

在上面的代码中，首先引入了 Express 模块，然后创建了一个 Router 实例。接着，定义了一个 GET 请求的路由，当访问根路径时，会返回一个字符串“Hello World!”。最后，将路由模块导出。

步骤五：创建控制器

在 Express 中，控制器是用于处理业务逻辑的模块。可以在项目根目录下创建一个 controllers 目录，用于存放控制器模块。在 controllers 目录中创建一个名为 user.js 的文件，用于定义用户相关的控制器。

// javascriptcn.com 代码示例
const User = require('../models/user');

// 获取所有用户
exports.getUsers = (req, res) => {
  User.find((err, users) => {
    if (err) {
      res.status(500).send(err);
    } else {
      res.json(users);
    }
  });
};

// 获取单个用户
exports.getUser = (req, res) => {
  User.findById(req.params.id, (err, user) => {
    if (err) {
      res.status(500).send(err);
    } else if (!user) {
      res.status(404).send('User not found');
    } else {
      res.json(user);
    }
  });
};

// 创建用户
exports.createUser = (req, res) => {
  const user = new User(req.body);
  user.save((err, user) => {
    if (err) {
      res.status(500).send(err);
    } else {
      res.json(user);
    }
  });
};

// 更新用户
exports.updateUser = (req, res) => {
  User.findByIdAndUpdate(req.params.id, req.body, { new: true }, (err, user) => {
    if (err) {
      res.status(500).send(err);
    } else if (!user) {
      res.status(404).send('User not found');
    } else {
      res.json(user);
    }
  });
};

// 删除用户
exports.deleteUser = (req, res) => {
  User.findByIdAndRemove(req.params.id, (err, user) => {
    if (err) {
      res.status(500).send(err);
    } else if (!user) {
      res.status(404).send('User not found');
    } else {
      res.json(user);
    }
  });
};

在上面的代码中，首先引入了 User 模型，然后定义了五个控制器方法，分别用于获取所有用户、获取单个用户、创建用户、更新用户和删除用户。这些控制器方法都接受 req 和 res 两个参数，分别表示请求和响应。在这些控制器方法中，调用了 User 模型的方法来进行 CRUD 操作，并根据操作结果返回相应的响应。

步骤六：创建数据模型

在 Express 中，数据模型用于定义数据结构和操作数据。可以在项目根目录下创建一个 models 目录，用于存放数据模型。在 models 目录中创建一个名为 user.js 的文件，用于定义用户数据模型。

// javascriptcn.com 代码示例
const mongoose = require('mongoose');
const Schema = mongoose.Schema;

const userSchema = new Schema({
  name: String,
  age: Number,
  email: String,
});

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

在上面的代码中，首先引入了 mongoose 模块，然后定义了一个名为 userSchema 的数据模型。这个数据模型包含了三个属性：name、age 和 email。最后，将数据模型导出。

步骤七：连接数据库

在 Express 中，可以使用 mongoose 模块来连接 MongoDB 数据库。可以在项目根目录下创建一个名为 db.js 的文件，用于连接数据库。

// javascriptcn.com 代码示例
const mongoose = require('mongoose');

mongoose.connect('mongodb://localhost/restful-api', {
  useNewUrlParser: true,
  useUnifiedTopology: true,
});

const db = mongoose.connection;

db.on('error', console.error.bind(console, 'connection error:'));
db.once('open', () => {
  console.log('Connected to MongoDB');
});

在上面的代码中，首先引入了 mongoose 模块，然后使用 connect 方法连接 MongoDB 数据库。连接字符串中的 restful-api 表示数据库的名字。接着，定义了一个 db 变量，用于表示数据库连接。最后，监听数据库连接的事件，并在连接成功后输出一条信息。

步骤八：使用路由和控制器

在 Express 中，可以使用路由和控制器来处理 HTTP 请求和响应。可以在 index.js 文件中引入路由和控制器，并使用它们来处理请求和响应。

// javascriptcn.com 代码示例
const express = require('express');
const bodyParser = require('body-parser');
const routes = require('./routes');
const db = require('./db');

const app = express();

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

app.use('/', routes);

app.listen(3000, () => {
  console.log('Server started on port 3000');
});

在上面的代码中，首先引入了 express、body-parser、routes 和 db 模块。接着，创建了一个 express 实例，并使用 body-parser 中间件来解析请求体中的数据。然后，使用 app.use 方法将路由模块挂载到根路径下。最后，监听端口 3000 并输出一条信息。

示例代码

完整的示例代码可以在 GitHub 上找到：https://github.com/linxiaowu66/Node-RESTful-API

总结

本文介绍了如何用 Node.js 搭建 RESTful API，包括路由、控制器、数据存储等方面的内容。通过本文的学习，可以掌握 RESTful API 的设计和实现方法，并能够使用 Node.js 快速搭建自己的 RESTful API。

来源：JavaScript中文网，转载请注明来源本文地址：https://www.javascriptcn.com/post/6586b63ed2f5e1655d117569