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

随着互联网的快速发展，Web 应用程序成为了人们日常生活中不可或缺的一部分。而作为 Web 应用程序的后端，RESTful API 更是承载着 Web 应用程序的核心功能。本文将介绍如何使用 Node.js + Express + Sequelize 搭建一个完整的 RESTful API，帮助读者快速掌握这些技术的使用方法。

什么是 RESTful API

RESTful API 是一种采用 HTTP 协议进行通信的 API，它对资源的操作包括获取、创建、修改和删除等，与传统的 RPC（Remote Procedure Call）相比，RESTful API 更加简洁、灵活、易于扩展和维护。RESTful API 通常使用 JSON 或 XML 格式传输数据，可以被各种编程语言和平台调用。

Node.js

Node.js 是一个基于 Chrome V8 引擎的 JavaScript 运行环境，它可以使 JavaScript 在服务器端运行。Node.js 的优点包括高效、可扩展、跨平台等，因此它成为了 Web 开发中的重要组成部分。

Express

Express 是一个基于 Node.js 的 Web 开发框架，它提供了一组灵活的功能，使得开发 Web 应用程序变得更加容易。Express 的优点包括简单易学、高效快速、灵活可扩展等。

Sequelize

Sequelize 是一个基于 Node.js 的 ORM（Object Relational Mapping）框架，它提供了一组简单易用的 API，使得开发者可以通过 JavaScript 对关系型数据库进行操作。Sequelize 支持多种数据库，包括 MySQL、PostgreSQL、SQLite 等。

搭建 RESTful API

1. 安装 Node.js 和 Express

在开始搭建 RESTful API 之前，需要先安装 Node.js 和 Express。可以通过以下命令来安装：

npm install express --save

2. 创建 Express 应用程序

创建一个名为 app.js 的文件，输入以下代码：

const express = require('express');
const app = express();
const port = 3000;

app.listen(port, () => {
  console.log(`Server running at http://localhost:${port}`);
});

该代码创建了一个 Express 应用程序，并监听了本地的 3000 端口。

3. 添加路由

在 Express 应用程序中，路由用于定义客户端请求的 URL 和服务器响应的动作。可以通过以下代码来添加路由：

app.get('/', (req, res) => {
  res.send('Hello World!');
});

该代码定义了一个 GET 请求的路由，当客户端请求根路由时，服务器将返回一个字符串 "Hello World!"。

4. 安装 Sequelize

在继续搭建 RESTful API 之前，需要先安装 Sequelize。可以通过以下命令来安装：

npm install sequelize mysql2 --save

5. 连接数据库

在使用 Sequelize 对数据库进行操作之前，需要先连接数据库。可以通过以下代码来连接 MySQL 数据库：

// javascriptcn.com 代码示例
const Sequelize = require('sequelize');
const sequelize = new Sequelize('database', 'username', 'password', {
  host: 'localhost',
  dialect: 'mysql'
});

sequelize.authenticate()
  .then(() => {
    console.log('Database connected');
  })
  .catch(err => {
    console.error('Unable to connect to the database:', err);
  });

该代码创建了一个 Sequelize 实例，并连接了名为 database 的 MySQL 数据库，用户名为 username，密码为 password。如果连接成功，将会在控制台输出 "Database connected"。

6. 定义模型

在使用 Sequelize 对数据库进行操作之前，需要先定义模型。模型是用于描述数据库中的表结构的 JavaScript 类，它们包含了表名、列名、数据类型等信息。可以通过以下代码来定义一个名为 User 的模型：

// javascriptcn.com 代码示例
const { Model, DataTypes } = require('sequelize');

class User extends Model {}

User.init({
  firstName: {
    type: DataTypes.STRING,
    allowNull: false
  },
  lastName: {
    type: DataTypes.STRING,
    allowNull: false
  },
  email: {
    type: DataTypes.STRING,
    allowNull: false,
    unique: true
  },
  password: {
    type: DataTypes.STRING,
    allowNull: false
  }
}, {
  sequelize,
  modelName: 'User'
});

该代码定义了一个名为 User 的模型，它包含了 firstName、lastName、email 和 password 四个属性，分别表示用户的名字、姓氏、电子邮件和密码。

7. 添加路由

在定义好模型之后，可以通过路由来对数据库进行操作。可以通过以下代码来添加路由：

// javascriptcn.com 代码示例
app.get('/users', async (req, res) => {
  const users = await User.findAll();
  res.json(users);
});

app.post('/users', async (req, res) => {
  const { firstName, lastName, email, password } = req.body;
  const user = await User.create({ firstName, lastName, email, password });
  res.json(user);
});

app.put('/users/:id', async (req, res) => {
  const { id } = req.params;
  const { firstName, lastName, email, password } = req.body;
  const user = await User.findByPk(id);
  user.firstName = firstName;
  user.lastName = lastName;
  user.email = email;
  user.password = password;
  await user.save();
  res.json(user);
});

app.delete('/users/:id', async (req, res) => {
  const { id } = req.params;
  const user = await User.findByPk(id);
  await user.destroy();
  res.json({ message: 'User deleted' });
});

该代码定义了四个路由，分别对应获取所有用户、创建用户、更新用户和删除用户。其中，GET /users 路由使用 User.findAll() 方法获取所有用户，POST /users 路由使用 User.create() 方法创建用户，PUT /users/:id 路由使用 User.findByPk() 方法查找指定的用户，并使用 user.save() 方法更新用户，DELETE /users/:id 路由使用 User.findByPk() 方法查找指定的用户，并使用 user.destroy() 方法删除用户。

示例代码

完整的示例代码如下：

// javascriptcn.com 代码示例
const express = require('express');
const { Model, DataTypes } = require('sequelize');

const sequelize = new Sequelize('database', 'username', 'password', {
  host: 'localhost',
  dialect: 'mysql'
});

class User extends Model {}

User.init({
  firstName: {
    type: DataTypes.STRING,
    allowNull: false
  },
  lastName: {
    type: DataTypes.STRING,
    allowNull: false
  },
  email: {
    type: DataTypes.STRING,
    allowNull: false,
    unique: true
  },
  password: {
    type: DataTypes.STRING,
    allowNull: false
  }
}, {
  sequelize,
  modelName: 'User'
});

const app = express();
const port = 3000;

app.use(express.json());

app.get('/', (req, res) => {
  res.send('Hello World!');
});

app.get('/users', async (req, res) => {
  const users = await User.findAll();
  res.json(users);
});

app.post('/users', async (req, res) => {
  const { firstName, lastName, email, password } = req.body;
  const user = await User.create({ firstName, lastName, email, password });
  res.json(user);
});

app.put('/users/:id', async (req, res) => {
  const { id } = req.params;
  const { firstName, lastName, email, password } = req.body;
  const user = await User.findByPk(id);
  user.firstName = firstName;
  user.lastName = lastName;
  user.email = email;
  user.password = password;
  await user.save();
  res.json(user);
});

app.delete('/users/:id', async (req, res) => {
  const { id } = req.params;
  const user = await User.findByPk(id);
  await user.destroy();
  res.json({ message: 'User deleted' });
});

sequelize.authenticate()
  .then(() => {
    console.log('Database connected');
    app.listen(port, () => {
      console.log(`Server running at http://localhost:${port}`);
    });
  })
  .catch(err => {
    console.error('Unable to connect to the database:', err);
  });

总结

本文介绍了如何使用 Node.js + Express + Sequelize 搭建一个完整的 RESTful API，包括连接数据库、定义模型、添加路由等步骤。希望读者能够通过本文的介绍，快速掌握这些技术的使用方法，并能够在实际的开发中灵活运用。

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