如何使用 Express.js 构建 RESTful API？附完整实例-JavaScript中文网-JavaScript教程资源分享门户

在现代的 Web 开发中，RESTful API 已经成为了不可或缺的一部分。Express.js 是一个流行的 Node.js Web 框架，它提供了构建 RESTful API 的工具和功能。本文将详细介绍如何使用 Express.js 构建 RESTful API，并附上完整的实例代码。

什么是 RESTful API？

RESTful API 是一种 Web API 的设计风格，它基于 HTTP 协议，使用 HTTP 动词（GET、POST、PUT、DELETE 等）操作资源（资源可以是一篇文章、一张图片、一段视频等），并使用 URI（统一资源标识符）标识资源。RESTful API 的设计原则是简单、可扩展、可靠、可缓存、可管理和可安全。

使用 Express.js 构建 RESTful API

Express.js 是一个基于 Node.js 的 Web 框架，它提供了构建 RESTful API 所需的工具和功能。下面是使用 Express.js 构建 RESTful API 的步骤：

第一步：安装 Express.js

在开始构建 RESTful API 之前，我们需要先安装 Express.js。在命令行中输入以下命令来安装 Express.js：

npm install express

第二步：创建 Express.js 应用

在安装了 Express.js 后，我们可以创建一个 Express.js 应用。在命令行中输入以下命令来创建一个 Express.js 应用：

express myapp

这将创建一个名为 myapp 的 Express.js 应用。在 myapp 目录下，我们可以看到以下文件和目录：

// javascriptcn.com 代码示例
myapp/
├── app.js
├── bin/
│   └── www
├── package.json
├── public/
│   ├── images/
│   ├── javascripts/
│   └── stylesheets/
│       └── style.css
└── views/
    ├── error.ejs
    └── index.ejs

第三步：定义路由

在 Express.js 应用中，路由是指将 URL（统一资源定位符）和 HTTP 动词映射到相应的处理程序（也称为控制器）。我们可以使用 Express.js 的路由来定义 RESTful API。

在 myapp/app.js 文件中，我们可以看到以下代码：

var indexRouter = require('./routes/index');
var usersRouter = require('./routes/users');

app.use('/', indexRouter);
app.use('/users', usersRouter);

这里使用了两个路由：indexRouter 和 usersRouter。其中，/ 和 /users 是 URL，indexRouter 和 usersRouter 是处理程序。

我们可以在 routes 目录下创建一个新文件，例如 myapp/routes/api.js，来定义我们的 API 路由。在 myapp/routes/api.js 文件中，我们可以定义如下路由：

var express = require('express');
var router = express.Router();

router.get('/api', function(req, res, next) {
  res.json({ message: 'Hello, world!' });
});

module.exports = router;

这里我们定义了一个 GET 请求路由，它的 URL 是 /api，返回的是一个 JSON 对象，包含了一个 message 字段。

第四步：启动 Express.js 应用

在完成了路由的定义之后，我们可以启动 Express.js 应用。在命令行中输入以下命令来启动 Express.js 应用：

npm start

这将启动一个 Web 服务器，并监听 3000 端口。在浏览器中访问 http://localhost:3000/api，我们可以看到如下输出：

{ "message": "Hello, world!" }

至此，我们完成了使用 Express.js 构建 RESTful API 的全部步骤。

完整实例代码

下面是一个完整的使用 Express.js 构建 RESTful API 的实例代码：

// javascriptcn.com 代码示例
// 引入依赖
var express = require('express');
var bodyParser = require('body-parser');

// 创建 Express.js 应用
var app = express();

// 使用 bodyParser 中间件
app.use(bodyParser.urlencoded({ extended: true }));
app.use(bodyParser.json());

// 定义路由
var router = express.Router();

router.get('/api', function(req, res, next) {
  res.json({ message: 'Hello, world!' });
});

router.post('/api', function(req, res, next) {
  res.json({ message: 'Hello, ' + req.body.name + '!' });
});

// 注册路由
app.use('/', router);

// 启动 Express.js 应用
app.listen(3000, function() {
  console.log('Express.js app listening on port 3000!');
});

在这个实例代码中，我们使用了 bodyParser 中间件来解析 HTTP 请求体。我们还定义了两个路由：一个 GET 请求路由，一个 POST 请求路由。GET 请求路由的 URL 是 /api，返回的是一个 JSON 对象，包含了一个 message 字段。POST 请求路由的 URL 也是 /api，它从 HTTP 请求体中获得一个 name 字段，并将其添加到返回的 JSON 对象中。

总结

本文介绍了如何使用 Express.js 构建 RESTful API。我们首先介绍了 RESTful API 的设计原则和 Express.js 的基本概念。然后，我们演示了如何使用 Express.js 定义路由和启动应用，并给出了一个完整的实例代码。希望本文对你有所帮助，能够让你更好地理解和使用 Express.js 构建 RESTful API。

来源：JavaScript中文网，转载请注明来源 https://www.javascriptcn.com/post/6511374195b1f8cacd99e696