RESTful Web服务最佳实践

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

最佳实践是消费者至上。这意味着, 请始终考虑你的消费者。在命名你的资源之前, 请从客户的角度考虑, 他们如何看待这些资源？他们将能够理解这些资源吗？

消费者至上

我们必须拥有有关API的出色文档。 Swagger是RESTful API最受欢迎的文档标准之一。确保我们的消费者了解我们制作的文档。

下一个最佳实践是充分利用HTTP。 RESTful Web服务基于HTTP。充分利用请求方法。使用适合于我们特定操作的正确请求方法（GET, POST, PUT和DELETE）, 并确保我们将适当的响应状态发送回去。

例如, 当找不到ESOURCE时, 不要发送服务器错误。创建资源后, 请勿发送成功, 请发送回创建的资源。

确保URI中没有安全信息。考虑一下你要在URI中放入的内容。确保URI中没有安全的东西。

始终使用复数。在前面的示例中, 我们使用/ users而不是/ user。同样, 为了访问资源, 我们使用了/ users / 1而不是/ user / 1。它比使用单数更具可读性。

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

例如, 如果我们在要点上放了一个星星, 那么Github会将请求发送到要点的资源（/ gists / {id}）, 然后在URI中发送一个带有星星的放置请求。