RESTful API 是一种广泛应用于 Web 开发和移动应用开发的基于 HTTP 协议的 API 设计规范。在 Node 应用中使用 RESTful API 设计，可以方便实现数据的增删改查等操作。然而，由于设计不当或者缺乏经验，可能会引入一些常见的设计误区。本文将介绍常见的 Node RESTful API 设计误区以及优化方法，旨在帮助前端工程师更好地设计 RESTful API。
误区一：过度依赖 HTTP 方法
HTTP 协议定义了多种方法，例如 GET、POST、DELETE、PUT 等，这些方法用于描述对服务器资源的不同操作。RESTful API 设计通常会根据这些方法来定义对资源的操作。然而，有些开发者会过度依赖 HTTP 方法，将所有的操作都限制在这些方法内，这样会导致设计过于僵化。
例如，有些开发者会将 GET 方法用于查询资源，POST 方法用于新增资源，PUT 方法用于更新资源，DELETE 方法用于删除资源，这些操作方式是没有问题的，但是有些情况下并不适用。比如，一个新闻网站可以使用 POST 方法发布新闻，但是此时使用 PUT 方法也没有问题。
解决方法：不要过度依赖 HTTP 方法，根据实际情况选择合适的方法来操作资源。
误区二：过多重复的 URIs
RESTful API 的 URI 通常由资源名和 ID 组成，例如 /users/1、/news/1 等。有些开发者为了方便，将请求的 URIs 设计得过多重复，例如 /users/1/user、/news/1/news 等。这样的设计虽然可以使用同一个接口对资源的不同属性进行操作，但是对于 API 的使用者来说，API 格式不够清晰，难以理解。
解决方法：避免过多重复的 URI，将 API 的格式设计得清晰易懂。
误区三：错误的状态码
HTTP 协议定义了许多状态码，例如 200、401、404 等，这些状态码用于描述 HTTP 请求的处理结果。有些开发者会错误地使用状态码，例如将 404 状态码用于描述应用程序未处理的错误，这是不正确的。
解决方法：使用正确的状态码，例如 404 状态码表示请求的资源不存在，400 状态码表示请求参数错误等。
误区四：缺乏数据验证
RESTful API 设计需要考虑数据的正确性和完整性。有些开发者缺乏对数据的验证，从而导致 API 容易受到攻击。
例如，一个 API 的请求参数中包含了密码和用户名，如果缺少密码验证，那么攻击者可以通过不断尝试用户名的方式来暴力破解密码。
解决方法：对 API 中的数据进行验证，例如对密码进行加密、限制输入参数等。
误区五：不恰当的错误响应
API 的请求可能存在许多错误，例如请求参数错误、资源不存在等。有些开发者会使用同样的错误响应格式来处理不同的错误，此时 API 的使用者很难通过错误码来判断错误类型。
解决方法：针对不同的错误类型使用不同的错误响应格式，方便 API 的使用者对错误的类型进行判断。
示例代码：
-- -------------------- ---- -------
-- --- ----
--------------------- ----- ---- -- -
----- ------ - -------------
-- ----
----- ---- - ----------------
-- ------- -
-- -----
----------------------
------ -----------------
-------- -------
--
- ---- -
--------------
-
--
-- -- --- -- ---- ----------
----- --- - --------------
-- --------
----- ------ - ------------
--------- ------------
-----------
-------
--------
------------
--------- ------------
------------ ------------------------------
------------
---------------- -------------------
--
--------------------- ----- ---- -- -
----- - --------- -------- - - --------
-- ----
----- - ------ ----- - - ----------------- --------- -------- --
-- ------- -
----------------------
------ ------------------
-------- -------------
--
- ---- -
-- ----
---------------------- ---------
----------
-------- ----
--
-
--总结
RESTful API 设计需要避免过度依赖 HTTP 方法、重复的 URI、错误的状态码、缺乏数据验证和错误响应等误区。正确使用 RESTful API 设计可以提高 API 的可用性和安全性，同时也可以提高开发效率和用户体验。希望本文的介绍可以帮助前端工程师更好地设计 RESTful API。
来源：JavaScript中文网 ，转载请注明来源 https://www.javascriptcn.com/post/64923dd448841e989400fb40