随着API的普及和使用，确保API的幂等性越来越重要。这是一个保证我们的API请求只会产生一个操作结果的重要概念。简单来说，幂等性可以保证在一次失败请求发生的情况下，再次提交额外的请求不会导致不良影响。
什么是幂等性？
在计算机科学中，幂等性是指无论执行多少次相同的操作，结果都不会改变。在 RESTful API 中，HTTP 方法的幂等性保证了客户端无论是发送一个请求一次还是多次，都只会产生一次结果。
幂等RESTful API的好处
我们为什么要保证API的幂等性？
- 保证网络环境不稳定的情况下API请求的正确性。
- 保证API请求在失败后能够重试，而不会引起意外行为。
- 保证容错性，防止意外的状态改变。
如何保证幂等性
保证API的幂等性需要遵循以下几条规则：
- 无副作用：API的请求不应该导致状态改变，例如删除操作，没有找到资源也应该返回200 OK。在任何情况下，任何正常的请求都应该引起一个相同的响应。
- 表 idempotency key：应该使用表 idempotency key 来保证同一请求的唯一性。ID重复请求要返回先前的响应。
- 幂等动作：幂等动作是指一次或多次请求的结果始终一致，如 PUT 和 DELETE 请求，每次重新请求结果都相同，这就是幂等性。
以下是一些保证幂等性的技巧：
唯一标识符
使用唯一标识符来标识每个请求。在RESTful API中，这通常意味着使用HTTP头或查询参数。例如，重要的 API 请求可能需要事务 ID，这将作为幂等键。
后向兼容性
新版本的API应该始终向后兼容，以避免与旧客户端的行为冲突。具体而言，新版本不应该更改现有API的操作，使其不再幂等。
客户端请求
客户端应该在所有需要幂等性的API请求中设置幂等键。这有助于保证不同客户端的请求唯一性。
重试机制
应该考虑实现一些在网络错误或其他情况下的重试机制。调用API尝试后再次尝试将不会有任何副作用。
示例代码
在Node.js中，我们可以使用uuid来生成唯一标识符作为幂等键。以下是一个示例代码：
-- -------------------- ---- -------
----- ------- - ------------------
----- ------ - ------------------
----- --- - ---------
----- -------- - --
--------------------- ----- ---- -- -
----- --------------- - ------------------------------ -- -------------------------
-- ------------------ -
------ ---------------------- -------- ---------------- -- ------------
-
-- --------------------------- -
------ -----------------------------------------------
-
----- -------- - -
--- ---------
----- --------
-
------------------------- - --------
------------------------------
--
---------------- -- -- -------------------- --- --------- -- ---- --------在这个例子中，我们使用一个对象来模拟一个数据库。/resource 是一个POST请求API的路由，客户端需要提供一个幂等键，以确保同样的操作不会再次创建新记录。如果提供的idempotent键已经存在，则返回先前的资源。
结论
保证RESTful API的幂等性是很重要的。遵循这些技巧并使用唯一标识符来标识每个请求，可以确保客户端在网络中断或其他错误情况下仍会得到正确的响应。
来源：JavaScript中文网 ，转载请注明来源 https://www.javascriptcn.com/post/67447fa8c1a23897ea77dd97