rest - 如何在 REST API 中表示实际上不是资源的函数？

Question

在定义 REST API 时，名词通常表示可以应用 HTTP 动词的资源。

例如:GET /user/profile/{id}或 POST /user/profile .

但并非所有功能都可以用典型资源表示。例如，需要验证注册 key 和 secret 的组合。我将如何在 REST API 中表示该方法？

Answer 1

您的问题的具体答案是:

POST to /RegistrationValidation
Request body:
{
    "key": "..."
    "secret": "..."
}

如果服务器接收到的数据有效，则以 200 OK 响应，如果无效，则返回其他状态代码。

这里的重点是:

您的 API 资源不应一对一映射到您的域模型。在设计 API 时，您不应该总是坚持 CRUD 风格。

您可以在 中自由设计您的 API细纹 , 粗粒风格或混合它们 如果最终它对消费客户友好。任何动词都可以是“名词化”，你最终会得到一个新的资源。您可以拥有修改多个底层域模型来解决特定业务需求的资源，这完全没问题。但要与你的决定保持一致，不要忘记自由意味着责任。您有一个无限的 URI 空间，但请确保您不会因为可以而获得大量资源。

在我写这个答案的时候，我回想起我在哪里看到了所有这些建议，我很高兴这篇 2014 年的文章仍然存在，我真的推荐它:
https://www.thoughtworks.com/insights/blog/rest-api-design-resource-modeling