REST API 设计的 8 个最佳实践

1. 自动缓存

重复的请求和响应会消耗资源，这体现了设计缺陷。为了解决这个问题，您必须将从 API 获取的数据存储在服务器上，之后再从那里提供数据。
然而，有时数据会过期，需要更新。在这种情况下，我们有一些行业缓存解决方案（Redis 和 Amazon ElasticCache），即使在数据发生更改后也可以缓存它们。

2. API 文档

任何 API 都必须提供清晰简洁的文档，否则以后使用该 API 会变得更加困难。因此，请确保您的 API 拥有良好的文档，使用简洁的语言编写，并及时更新和发布新版本。
您的 API 文档应包含以下内容：

简单易读的语言。
以不同的编程语言实现 API。

3. 不要返回纯文本

在 REST 架构中，没有必要超越 JSON，因为大多数 REST API 都使用 JSON 作为数据格式。但有时返回包含 JSON 格式字符串的主体是不够的。

例如，您可以指定将 Content-Type 标头设置为值 application/json。

4. 401 与 403

这两个状态码的含义不同，很容易让人混淆它们究竟是与身份验证相关还是与授权相关。为了更快地解决问题，您需要了解它们之间的区别。
如果用户未提供身份验证详细信息或身份验证信息无效，则返回 401 未授权。
如果用户身份验证成功但未提供访问资源的权限，则返回 403 禁止访问。

阅读更多：https ://javascript.plainenglish.io/8-best-practices-for-rest-api-design-3fd1b837b283