在构建 Web 应用程序时，RESTful API（Representational State Transfer）是一种流行的架构风格。它是一种 Web 服务技术，允许应用程序以标准化方式进行通信，应用程序可以使用各种语言和库，无论它们运行在哪个平台。利用 RESTful API，我们可以为 Web 应用程序提供方便、简化和标准化的接口。
然而，构建一个垂直的 Web 应用程序需要遵循一些规则和最佳实践，特别是当我们处理大量数据、复杂的查询、与其他应用程序进行交互时。本文将向您介绍一些最佳实践，这些最佳实践将帮助您优化和精简 RESTful API。
规范化 API 接口
尽管我们很容易创建一个 RESTful API 接口，但我们必须使用一些规范化的方法来确保它们可读性和一致性。
命名规范
使用恰当、简单和有意义的命名方便其他开发人员（包括未来的自己）理解和使用 API。我们建议采用以下约定：
- URL 中使用小写字母；
- 相关资源使用复数形式；
- 使用中横线（-）作为单词间的分隔符，例如
/posts/comments； - URL 的末尾不需要
/。
实用标准 HTTP 方法
在 RESTful API 中，标准 HTTP 方法是必须的，因此我们必须确保使用它们。以下是一些 HTTP 方法及其用途：
- GET：获取一个或多个资源；
- POST：新建资源；
- PUT：替换资源；
- PATCH：更新资源；
- DELETE：删除资源。
错误处理
我们必须使用恰当、明确和友好的错误消息，以便其他开发人员和客户端应用程序能够使用 API。如果出现错误，我们应该发送适当的 HTTP 状态码和错误消息。常见的状态码如下：
- 200 OK：表示请求已成功处理；
- 201 Created：表示成功创建了一个新资源；
- 204 No Content：表示成功删除资源；
- 400 Bad Request：表示显式的请求无效；
- 401 Unauthorized：表示请求的经过身份验证的用户没有权限；
- 403 Forbidden：表示服务器拒绝访问请求；
- 404 Not Found：表示找不到请求的资源；
- 500 Internal Server Error：表示服务器遇到了错误。
优化 RESTful API
下面是一些优化 RESTful API 接口的建议：
缩减响应体
避免返回不必要的数据，只返回必要的信息。如果接收数据的客户端不需要整个对象，我们可以缩减响应体。例如，如果我们有一个对象user：
-- -------------------- ---- ------- - ------ --------------------------- ------------ ------- ----------- ------ -------- ---------------------- ----------- --------------------------------------------------------------- ------------ --------------------------- ------------ --------------------------- ------ - -
客户端可能只需要知道用户的姓名和电子邮件，因此我们可以缩小响应体，仅返回所需的信息：
{
"firstname": "John",
"lastname": "Doe",
"email": "johndoe@example.com"
}要在 Node.js 中处理这种情况，我们可以在控制器中使用 Projection：
-- -------------------- ---- -------
--------------- - ----- ----- ---- ----- -- -
----- ---- - ----- -------------------------------- -
---- --
---------- --
--------- --
------ -
---
---------------
--分页
分页是记录集中分页的过程，并通过将数据拆分为较小的部分来提高性能。使用分页机制，我们可以减少响应数据的大小，并且可以更快地处理数据。我们可以在 query string 参数中传递 limit 和 offset。例如，我们的请求可能包含以下参数：
GET /api/posts?limit=10&offset=0
Node.js 代码可能如下：
exports.getPosts = async (req, res, next) => {
const limit = parseInt(req.query.limit) || 10;
const offset = parseInt(req.query.offset) || 0;
const posts = await Post.find().limit(limit).skip(offset);
res.send(posts);
};缓存
缓存是一种用于减少数据访问时间和提高性能的技术。在 RESTful API 中，我们可以使用专业的工具，例如 Redis 或 Memcached。我们可以设置一个 TTL（时间到期），来指定缓存过期的时间。
以下是 Node.js 中使用 Redis 进行缓存的示例：
-- -------------------- ---- -------
----- ----- - -----------------
----- ------ - ---------------------
---------------- - ----- ----- ---- ----- -- -
----- ----- - ------------------------- -- ---
----- ------ - -------------------------- -- --
----- -------- - ---------------------------
-------------------- ----- ----- ------- -- -
-- -------- -
----------------- ------- ----------
-----------------------------
- ---- -
----------------- --------- ----------
----- ----- - ----- --------------------------------------
---------------------- ---- -----------------------
----------------
-
---
--总结
通过遵循 RESTful API 的最佳实践和使用一些技巧和技术，我们可以让我们的 API 更加优化和精简。总结本篇文章的内容：
- 使用命名约定，使 API 更易于理解和使用；
- 必须使用标准 HTTP 方法；
- 对错误进行恰当的处理；
- 缩减响应体，只返回必要的信息；
- 分页以优化性能；
- 利用缓存来提高性能。
上述经验应该能帮助您构建更健壮、更可维护、更易于阅读和使用的 RESTful API。
参考链接
来源：JavaScript中文网 ，转载请注明来源 https://www.javascriptcn.com/post/64e70c25f6b2d6eab3264cf2