使用 Node.js 构建 RESTful API | Express.js 教程

介绍

在这个项目中，你将学习如何使用 Node.js 和 Express.js 开发一个 RESTful API。该项目涉及创建一个简单的用户管理系统，在其中你可以获取用户列表。

👀 预览

curl http://localhost:8080/list
## 输出：
## {"userlist":[{"id":"1","username":"zhangsan","password":"123456"},{"id":"2","username":"lilei","password":"456"},{"id":"3","username":"hanmeimei","password":"123"}]}

🎯 任务

在这个项目中，你将学习：

如何设置一个 Node.js 项目并安装依赖项
如何创建一个基本的 Express.js 服务器
如何实现一个 GET 端点，从 JSON 文件中获取用户列表
如何使用 cURL 测试 API

🏆 成果

完成这个项目后，你将能够：

理解 RESTful API 开发的基础知识
设置一个 Node.js 项目并安装必要的依赖项
创建一个简单的 Express.js 服务器
实现一个 GET 端点，从 JSON 文件中检索数据
使用 cURL 测试 API

设置项目

在这一步中，你将设置项目并安装必要的依赖项。

本题的初始代码已经提供。打开编码环境，目录结构如下：

├── index.js
├── users.json
├── package.json
├── package-lock.json

接下来，在终端中使用 npm install 命令下载依赖项，等待依赖项下载完成，然后使用 npm run dev 命令启动项目。

实现 GET /list 端点

在这一步中，你将实现 GET /list 端点以显示用户列表。

在项目目录中打开 index.js 文件。
在文件中找到 TODO 部分，并添加以下代码以实现 GET /list 端点：

//TODO
app.get("/list", function (req, res) {
  fs.readFile(
    path.resolve(__dirname, "./users.json"),
    "utf8",
    function (err, data) {
      data = JSON.parse(data);
      res.json(data);
    }
  );
});

这段代码读取 users.json 文件，解析 JSON 数据，并将其作为响应发送。

保存 index.js 文件。

测试 GET /list 端点

在这一步中，你将测试 GET /list 端点，以确保它能正常工作。

在实验环境中打开一个新的终端。
使用 curl 命令向 /list 端点发送一个 GET 请求：

curl http://localhost:8080/list

你应该会看到以下输出，这是来自 users.json 文件的 JSON 数据：

{"userlist":[{"id":"1","username":"zhangsan","password":"123456"},{"id":"2","username":"lilei","password":"456"},{"id":"3","username":"hanmeimei","password":"123"}]}

如果你看到了这个输出，说明 GET /list 端点工作正常。

恭喜你！你已经完成了这个项目，并实现了 GET /list 端点来显示用户列表。

总结

恭喜你！你已经完成了这个项目。你可以在 LabEx 中练习更多实验来提升你的技能。

使用 Node.js 构建用户管理 RESTful API

介绍