如何用 Node.js 和 Express.js 搭建 RESTful API

阅读时长 6 分钟读完

RESTful API 是一种常见的 Web API 设计风格,它采用 HTTP 协议中的 GET、POST、PUT、DELETE 等方法来实现对资源的操作。Node.js 和 Express.js 是两个非常流行的前端开发工具,它们可以用来搭建 RESTful API。本文将介绍如何使用 Node.js 和 Express.js 搭建 RESTful API,并提供示例代码。

准备工作

在开始之前,需要确保已经安装了 Node.js 和 Express.js。如果还没有安装,可以到官网下载安装包进行安装。安装完成后,在终端中输入以下命令来检查是否安装成功:

如果能够正确显示版本号,则说明安装成功。

创建项目

在终端中进入想要创建项目的目录,然后执行以下命令来创建一个新的 Express 项目:

这个命令将会在当前目录下创建一个名为 myproject 的文件夹,并在其中生成一个 Express 项目的基础结构。

安装依赖

进入 myproject 目录,执行以下命令来安装项目所需的依赖:

创建路由

在 myproject 目录下创建一个名为 routes 的文件夹,在其中创建一个名为 api.js 的文件。在 api.js 中编写以下代码:

这个代码片段创建了一个路由,当用户访问 /api 路径时,会返回一个字符串 "API is working properly"。

挂载路由

在 myproject 目录下的 app.js 文件中,找到以下代码:

在这两行代码的下方添加以下代码:

这个代码片段将刚刚创建的 api.js 路由挂载到了 /api 路径上。这意味着当用户访问 /api 路径时,会调用 api.js 中定义的路由处理函数。

测试 API

启动项目,执行以下命令:

然后在浏览器中访问 http://localhost:3000/api,应该会看到 "API is working properly" 这个字符串。

实现 CRUD 操作

上面的示例只是一个简单的路由,实际上 RESTful API 的主要功能是实现对资源的 CRUD 操作。下面我们将介绍如何使用 Node.js 和 Express.js 实现 CRUD 操作。

创建资源

在 api.js 中添加以下代码:

这个代码片段创建了一个 POST 请求路由,当用户向 /api 发送 POST 请求时,会将请求体中的数据存入数据库,并返回该数据。

获取资源列表

在 api.js 中添加以下代码:

这个代码片段创建了一个 GET 请求路由,当用户向 /api 发送 GET 请求时,会从数据库中获取资源列表,并返回该列表。

获取单个资源

在 api.js 中添加以下代码:

这个代码片段创建了一个 GET 请求路由,当用户向 /api/id 发送 GET 请求时,会从数据库中获取指定 id 的资源,并返回该资源。

更新资源

在 api.js 中添加以下代码:

这个代码片段创建了一个 PUT 请求路由,当用户向 /api/id 发送 PUT 请求时,会将请求体中的数据更新到数据库中,并返回更新后的数据。

删除资源

在 api.js 中添加以下代码:

这个代码片段创建了一个 DELETE 请求路由,当用户向 /api/id 发送 DELETE 请求时,会从数据库中删除指定 id 的资源,并返回 "Resource deleted successfully"。

结论

本文介绍了如何使用 Node.js 和 Express.js 搭建 RESTful API,并提供了示例代码。虽然本文只提供了基础的 CRUD 操作示例,但是这些操作已经足够覆盖大部分的 Web API 开发需求。希望本文能够对大家学习和使用 Node.js 和 Express.js 有所帮助。

来源:JavaScript中文网 ,转载请注明来源 https://www.javascriptcn.com/post/675d473fe1dcc5c0fa3a9243

纠错
反馈