构建 RESTful API 的最佳实践

最近，我一直在学习如何使用 Node.js 和 Express 构建 API。构建 API 没有固定的标准，但通过阅读网上资料，我发现了一些关于如何构建功能齐全、可用性强的 API 的常见主题。这些常见主题包括：

不返回纯文本

即使响应主体的格式类似于 JSON，如果响应标头未设置为 application/json，某些客户端在解析它时可能会遇到问题。

使用复数而不是单数

例如，使用 /articles/ 而不是 /article/

避免在 URI 中使用动词

使用 HTTP 动词（例如 GET、POST、PUT、PATCH、DELETE）让用户了解端点将执行的操作类型。
例如，使用 POST: /users/ 而不是 POST: /users/newUser/

始终在响应主体中返回带有错误消息的有意义的状态代码

如果请求不成功，API 应该返回错误状态，而不是像 200 这样的 ok 状态。如果响应主体中有错误消息，这对用户也很有帮助。

始终使用尾部斜杠

API 的所有端点都应该一致地使用尾部斜杠（例如 /users/）或不使用（例如 /users）。理想情况下，如果客户端使用其他版本的 URI，应该自动重定向到正确的端点。大多数框架都提供这样的选项，因此值得查找并使用它。

使用框架

随着 API 变得越来越复杂，值得花一些时间学习 API 框架，例如 Python 版的 Django REST Framework 或 Node.js 版的 Restify。使用特定于 API 的框架可以更轻松地保持 API 的一致性和可用性。