RESTful Web 服务最佳实践

在本节中，我们将评估在开发 RESTful Web Services 时必须遵循的最佳实践。

第一个也是最后一个最佳实践是**用户至上**。这意味着始终考虑您的用户。在命名资源之前，请从客户的角度考虑，他们对这些资源有何看法？他们是否能够理解这些资源？

用户至上

我们必须为我们的 API 提供优秀的文档。Swagger 是 RESTful API 最流行的文档标准之一。确保我们的用户理解我们生成的文档。

下一个最佳实践是充分利用 **HTTP**。RESTful web services 基于 HTTP。充分利用请求方法。使用正确的请求方法（**GET、POST、PUT 和 DELETE**）来执行我们的特定操作，并确保我们发送正确的响应状态。

例如，当**资源未找到**时，不要发送服务器错误。当资源被**创建**时，不要发送成功，而是发送已创建。

确保 URI 中没有安全信息。考虑一下您在 URI 中放入的内容。确保 URI 中没有任何安全信息。

始终使用复数。在之前的示例中，我们使用 /users 而不是 /user。同样，对于访问资源，我们使用 **/users/1 而不是 /user/1**。与使用单数相比，它更具可读性。

当我们考虑资源时，始终使用名词作为资源。但这并不总是可能的。总是有例外情况。对于所有这些例外情况，如果我们通过用户搜索，请定义一致的方法，例如使用 **/user/search**。

例如，如果我们在 gists 上加星，Github 会将请求发送到 **gists** (/gists/{id}) 的资源，并发送一个带有 URI 中星号的 put 请求。