SpringBoot教程-RESTful Web Services 最佳实践

RESTful Web Services 最佳实践
在这一部分，我们将评估在开发 RESTful Web Services 时必须遵循的最佳实践。

第一个和最后一个最佳实践是“以消费者为先”。这意味着，始终要从消费者的角度考虑。在为资源命名之前，从客户的角度思考，他们如何看待这些资源？他们能否理解这些资源？

消费者为先

我们必须为我们的API编写出色的文档。Swagger 是最流行的 RESTful API 文档标准之一。确保我们的消费者能够理解我们所编写的文档。

接下来的最佳实践是充分利用HTTP。RESTful web服务基于HTTP。充分利用请求方法。对于我们特定的操作，使用正确的请求方法（GET、POST、PUT和DELETE），并确保我们发送了适当的响应状态。

例如，当资源不存在时，不要发送服务器错误。当资源被创建时，不要发送成功消息，而是发送已创建消息。

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

始终使用复数形式。在之前的示例中，我们使用了 /users 而不是 /user。同样，在访问资源时，我们使用了 /users/1 而不是 /user/1。这比使用单数形式更具可读性。

当我们考虑资源时，始终为资源使用名词。但并不总是可能的。总会有例外情况。对于所有这些异常情况，如果我们在用户中进行搜索，定义一种一致的方法，使用 /user/search。

例如，如果我们在代码片段上加了一个星号，GitHub 将向代码片段的资源（/gists/{id}）发送请求，并发送一个带有星号的 PUT 请求。