构建强大REST API的十个最佳实践

在项目开发中，我们经常会使用REST风格进行API的定义，这篇文章为大家提供10条在使用REST API时的最佳实践。希望能够为你带来灵感和帮助。

1、使用具体且有意义的资源名称

选择能准确表示所代表实体的资源名称，而不要使用泛化或模糊的名称。

图片

这一条最佳实践非常明确，也就是说我们在使用REST API时，代表资源分类的部分，比如上图中的“users”和“customers”，使用users更泛化，不够具体，可能是To C的用户，也可能是To B或To G的用户。此时，最近确保定义的资源更具体，能够代表一定的清晰含义。

2、正确使用HTTP方法

根据不同的操作使用合适的HTTP方法（GET、POST、PUT、DELETE、PATCH等）。

图片

这一条涉及到HTTP方法的基本定义。举一个简单的例子来说明就是：一般提交表单操作，用POST请求，查询信息用GET请求。不要将两者颠掉或混用。当然，还有其他的HTTP方法，也是如此。

3、对API进行版本控制

使用版本控制确保向后兼容性，并允许在不破坏现有客户端的情况下进行未来的增强。

图片

为了保持版本的兼容性，依旧流量和功能的控制等，通常需要对API进行版本控制，这个是仅限于REST API，而是比较通用的一条最佳实践，特别是真的终端是App的情况。

4、正确使用HTTP状态码

返回适当的HTTP状态码以指示API请求的成功或失败。

图片

这一条也是非常基础的HTTP知识，不同的错误码代表着不同的含义，准确的返回错误码，可以让终端更加精准的识别错误。

5、选择JSON字段命名约定

JSON标准没有强制规定字段命名约定，但最佳实践是选择一个并坚持使用。

图片

选择适合团队和编程语言的JSON命名规则，具体采用哪种不重要，重要的是整个团队要确保统一。在个人的团队中，更习惯使用驼峰（camelCase）的形式。

6、使用一致的错误信息

在大多数情况下，仅使用HTTP状态码无法解释出现的错误。为了帮助API使用者，包含一个结构化的JSON错误消息。这里的JSON错误信息更偏向业务层面。而HTTP状态码更偏向于HTTP交互层面。

响应应包括以下信息：

• 错误代码：机器可读的错误代码，用于识别特定的错误条件。
• 错误消息：人类可读的消息，提供对错误的详细解释。
• 错误上下文：与错误相关的附加信息，例如请求ID、导致错误的请求参数或导致错误的请求中的字段。
• 错误链接：提供有关错误以及如何解决错误的附加信息或文档的URL。
• 时间戳：错误发生的时间。

7、使用查询参数进行过滤、排序和搜索

查询参数允许你在HTTP请求的URL中提供额外的信息，以控制服务器返回的响应。

图片

8、实施身份验证和授权

通过实施适当的身份验证和授权机制来保护API。

建议：

• 使用API密钥、令牌或OAuth 2.0进行身份验证
• 应用基于角色的访问控制（RBAC）进行授权

9、不要维护状态

REST API不应在服务器上维护状态，这是客户端的责任。这很重要，因为它可以使API具备可缓存性、可扩展性，并使其与客户端解耦。

例如，电子商务API可能使用cookie来维护购物车的状态。然而，这种方法违反了RESTful API的关键原则：它们需要是无状态的。

10、文档化你的API

为你的API提供全面的文档，包括端点细节、请求/响应示例和使用指南。

建议：

• Swagger/OpenAPI文档
• 基于Markdown的文档（例如，使用Swagger UI或Redoc等工具）