在现代 Web 开发中，RESTful API 已经成为了一种很常见的接口设计风格。使用 RESTful 接口可以方便地处理前后端之间的数据交互，提高了开发效率。
而使用 Node.js 开发 RESTful API，Express 是一个非常流行的框架。但是 Express 的路由设计有些繁琐，需要手动处理很多细节。这时候，我们可以使用一个名为 express-restful.ts 的 npm 包，它提供了一些能够自动化处理 Express 中 RESTful 路由的方法。
本文将会提供一个 express-restful.ts 的详细教程，包括如何使用它创建 RESTful API，以及它的一些高级特性。
安装
首先，我们需要在我们的项目中安装 express-restful.ts。可以通过 npm 命令行来完成安装：
npm install express-restful.ts
基本使用
安装完成后，我们可以在项目中导入 express-restful.ts：
-- -------------------- ---- ------- ------ ------- ---- ---------- ------ ------------- ---- --------------------- ----- --- - ---------- ----- ------ - ---------------- --------------- ----- ---- -- - ---------------- ------- ------- --- ------------ -------- ---------------- -- -- - -------------------- --- -- --------- -- ---- ---------- ---
在这个例子中，我们创建了一个 Express 应用程序，然后创建了一个 RestfulRouter 物件。在 RestfulRouter 上我们注册了一个 GET 路由，最后将它们挂载在应用程序上。
当我们启动应用程序时，它将会 listen 在 3000 端口上，在浏览器中打开 http://localhost:3000/，可以看到输出 Hello, RESTful API!。
资源路由
在 RESTful API 中，每个资源都应该有一个专用的 URL，并且应该使用 HTTP 动词来表示对资源的操作。express-restful.ts 可以帮助我们在 Express 上实现这个想法。
声明路由
首先，让我们在 RestfulRouter 上声明一个资源路由：
const users = router.resource('users');这段代码使用 resource 方法创建一个路由，用于处理 /users URL。
resource 方法除了资源名称之外，还可以传递一个对象，该对象可以包含有关资源的其他信息。
const users = router.resource('users', {
model: UserModel,
beforeActions: [authenticate],
afterActions: [log]
});上面这个例子中，我们传递了一个 model 对象，这个对象应该是实际表示资源的模型。还传递了两个数组 beforeActions 和 afterActions，这些数组中包含在操作执行前/后执行的中间件函数。
请求处理
声明了资源路由之后，我们可以定义每个资源的操作：
-- -------------------- ---- ------- ----------------- ---- -- - ------------- --------- --- ------------------ ---- -- - -------------- --------- --- ---------------- ---- -- - ------------- -------------------------- --- ------------------ ---- -- - --------------- -------------------------- --- ------------------- ---- -- - ---------------- -------------------------- ---
index 方法用于处理 GET 请求，用于获取所有的资源。
create 方法用于处理 POST 请求，用于创建新的资源。
show 方法用于处理 GET 请求，用于获取单个资源。
update 方法用于处理 PATCH 请求，用于更新某个资源。
destroy 方法用于处理 DELETE 请求，用于删除某个资源。
使用模型
如果您传递了一个模型对象，那么您可以在所有操作中使用它来处理数据库操作。
-- -------------------- ---- -------
----------------- ---- -- -
------------------ ----- ------ -- -
----------------
---
---
------------------ ---- -- -
----- ---- - --- --------------------
--------------- -- -
---------------
---
---
---------------- ---- -- -
--------------------------------- ----- ----- -- -
---------------
---
---
------------------ ---- -- -
------------------------------------------ --------- - ---- ---- -- ----- ----- -- -
---------------
---
---
------------------- ---- -- -
------------------------------------------ ----- ----- -- -
---------------
---
---上面这些代码都是使用 Mongoose 对 MongoDB 进行操作的代码，您可以根据您的需求来替换它们。
其他功能
除了基本的资源路由，express-restful.ts 也提供了许多其他功能。
自定义路由
RestfulRouter 提供了 router.route 方法，可以让您为指定的 URL 创建单独的路由。
例如，下面这个代码可以为 /users/:id/profile URL 创建一个 GET 路由：
router.route('/users/:id/profile').get((req, res) => {
// ...
});路由中间件
RestfulRouter 还提供了 router.middlewares 方法，用于为所有资源路由添加中间件。
router.middlewares([ authenticate, log ]);
资源路由中添加的中间件将会传递到所有子路由中。
路由前缀
如果您的应用程序需要统一的前缀路径来承载所有的 API 资源，可以使用 RestfulRouter 的 prefix 方法：
const apiRouter = RestfulRouter();
apiRouter.prefix('/api/v1');
const users = apiRouter.resource('users');
// ...这段代码将会为所有的资源路由 URL 添加 /api/v1 前缀。
结论
express-restful.ts 可以帮助您在 Express 上轻松创建 RESTful API。它的功能非常强大，而且易于使用。您可以使用它来处理基本的 CRUD 操作，也可以使用它来添加自定义的路由和中间件。最重要的是，它可以让您的代码更具可读性、可维护性和可测试性。
来源：JavaScript中文网 ，转载请注明来源 https://www.javascriptcn.com/post/6005595d81e8991b448d6c40