RESTful API 在现代 Web 开发中变得越来越常见,它们提供了一种基于 HTTP 协议的轻量级方式来访问和操作数据。Sequelize 是一个非常受欢迎的 Node.js ORM 库,它可以轻松地将数据模型映射到关系型数据库中。接下来,在本文中我们将介绍如何使用 Sequelize 和 Express.js 来创建一个 RESTful API,以及如何处理相关数据操作。
环境和前提条件
在开始本教程之前,需要确保已经安装了以下开发环境:
- Node.js 环境(包括 npm 包管理器)
- 关系型数据库管理系统,例如 MySQL 或 Postgres
- 一个代码编辑器,例如 Visual Studio Code 或 Atom
除此之外,还需要基本的 JavaScript、Node.js 和 SQL 数据库的知识。
初始 Express 项目
首先,我们需要创建一个新的 Express 项目。在命令行中输入以下命令,进入文件夹并执行初始化:
mkdir sequelize-restful-api && cd sequelize-restful-api npm init -y
然后,安装 Express.js 库:
npm install express --save
在项目文件夹中创建一个名为 index.js
的文件,并将以下代码复制到文件中:
const express = require('express') const app = express() app.listen(3000, () => console.log('API server listening on port 3000!'))
上面的代码将启动一个监听端口为 3000
的 Express 服务器。
现在,我们可以使用以下命令运行服务器:
node index.js
在浏览器中访问 http://localhost:3000
,我们将看到 “Cannot GET /” 的错误。
添加 Sequelize
Sequelize 是一个异步的 ORM 库,它可以将数据模型转换成关系型数据库中的表格、行和列。Sequelize 操作可以通过纯 JavaScript 代码实现,这使得它非常适合使用 Node.js 作为后端。在本教程中,我们将使用 Sequelize 连接到 MySQL 数据库。
在命令行中,输入以下命令来安装 Sequelize 和相关的依赖库:
npm install sequelize sequelize-cli mysql2 --save
接下来,我们将使用 Sequelize-CLI 工具来快速创建数据库以及相关的数据模型。在命令行中,输入以下命令:
npx sequelize-cli init
上面的命令将在项目文件夹中创建一个名为 models
的文件夹以及一些 Sequelize 相关配置文件。在 models
文件夹中,我们将创建一个 User
模型,用于存储我们的用户信息。在命令行中输入以下命令:
npx sequelize-cli model:generate --name User --attributes email:string,password:string
上面的命令将根据我们的输入创建一个名为 User
的模型,并生成一个包含 email
和 password
字段的 users
表。
打开 models/user.js
文件,我们将看到 Sequelize 自动生成的 User
模型定义;我们对其进行修改,以便于后面的数据库操作。
-- -------------------- ---- ------- -------------- - ----------- ---------- -- - ----- ---- - ------------------------ - ------ - ----- ----------------- ---------- ------ ------- ---- -- --------- - ----- ----------------- ---------- ----- - -- ------ ---- -
在上面的代码中,我们定义了一个 User
模型,包括两个属性:email
和 password
。这些属性都为字符串类型,email
属性具有 unique
属性,因此每个用户都必须有唯一的电子邮件地址。接下来,我们将在 server.js
文件中使用这个模型。
添加 Express 路由
接下来,我们需要创建一些路由来访问数据库操作。在 index.js
文件中添加以下代码:
-- -------------------- ---- ------- ----- ---- - --------------- ----- ---------- - ---------------------- ----- - --------- - - ------------------- ----- --- - --------- ----- ---- - ---------------- -- ---- --------------- -------------------------- ------------ ----- ---- -- - ------------- ------ --------- -- ---------------- ------ ----- ---------- -- - ---------------- -- -- - ---------------- ------ --------- -- ---- --------- -- --
上面的代码中,我们在 Express 中使用了两个中间件:cors
和 body-parser
,它们使我们的应用程序可以接受跨域请求和解析请求体中的 JSON 数据。
我们还将在 Sequelize 中使用 sequelize.sync()
方法,这个方法会自动同步我们的数据模型,并创建实际的数据库表格。
我们添加了一个简单的根路由以验证服务器是否正常运行。
接下来,我们将添加多个路由来处理用户数据 CRUD 操作:
-- -------------------- ---- ------- ----- - ---- - - ------------------- ----------------- ----- ---- -- - -------------- ----------- -- ---------------- ------------ -- ---------------------------- -- ------------------------- ----- ---- -- - -------------------------------- ---------- -- --------------- ------------ -- ---------------------------- -- ------------------ ----- ---- -- - --------------------- ---------- -- --------------- ------------ -- ---------------------------- -- ------------------------- ----- ---- -- - -------------------------------- ---------- -- ---------------------- ---------- -- --------------- ------------ -- ---------------------------- -- ---------------------------- ----- ---- -- - -------------------------------- ---------- -- --------------- -------- -- ------------- ------------ -- ---------------------------- --
在上面的代码中,我们定义了以下路由:
GET /users
:返回所有用户。GET /users/:userId
:返回指定 ID 的用户。POST /users
:创建一个新用户。PUT /users/:userId
:更新指定 ID 的用户。DELETE /users/:userId
:删除指定 ID 的用户。
接下来,我们将使用 Postman 或类似工具来测试这些路由。
测试路由
在 Postman 中创建一个新的 GET 请求到 http://localhost:3000/users
,我们将看到所有的用户数据以 JSON 格式输出。
接下来,创建一个 POST 请求到 http://localhost:3000/users
,在请求体中添加以下 JSON 数据:
{ "email": "test@example.com", "password": "123456" }
发送请求后,我们将返回新创建的用户的 JSON 数据。下一步,使用与上面相同的方式测试路由的其他操作。
结论
在本文中,我们学习了如何使用 Sequelize 和 Express.js 创建 RESTful API。我们开始了一个新的 Express 项目,并添加了 Sequelize、数据库模型以及路由。最后,我们使用 Postman 测试了各个路由的功能。
有了这些基础,我们可以继续扩展我们的 API,包括添加更多的数据模型、调用外部 API 以及添加身份验证和授权。
我们希望这篇文章对于新手有指导意义。如果您有任何问题或建议,请在下面留言。
来源:JavaScript中文网 ,转载请注明来源 https://www.javascriptcn.com/post/670f584e5f5512810263d057