我应该为REST资源使用单数还是复数名称约定?

一些基于rest的服务使用不同的资源uri进行更新/获取/删除和创建。如

Create -在某些地方使用/resource(单数)使用POST方法使用/resources(复数) 更新-使用PUT方法使用/resource/123 Get -使用Get方法使用/resource/123

我对这个URI命名约定有点困惑。我们应该用复数还是单数来创建资源?决定的标准应该是什么?

当前回答

请参阅谷歌的API设计指南:资源名称以了解另一种命名资源的方法。

该指南要求集合以复数形式命名。

|--------------------------+---------------+-------------------+---------------+--------------|
| API Service Name         | Collection ID | Resource ID       | Collection ID | Resource ID  |
|--------------------------+---------------+-------------------+---------------+--------------|
| //mail.googleapis.com    | /users        | /name@example.com | /settings     | /customFrom  |
| //storage.googleapis.com | /buckets      | /bucket-id        | /objects      | /object-id   |
|--------------------------+---------------+-------------------+---------------+--------------|

如果你正在思考这个问题，这本书值得一读。

2019-07-03 00:58:10

其他回答

在这个问题上有很好的讨论点。在我的经验中，命名约定或者更确切地说，没有建立本地标准是许多长夜待命、头痛、危险的重构、可疑的部署、代码审查辩论等等的根本原因。特别是当它决定事情需要改变，因为一开始就没有充分考虑到。

一个实际问题跟踪了关于这个问题的讨论:

https://github.com/kubernetes/kubernetes/issues/18622

在这个问题上看到分歧是很有趣的。

我的观点是，当你考虑用户、帖子、订单、文档等常见实体时，你应该始终将它们视为实际实体，因为这是数据模型的基础。这里不应该混淆语法和模型实体，这将导致其他方面的混淆。然而，一切都是黑白的吗?确实很少这样。环境真的很重要。

当你想获取系统中用户的集合时，例如:

GET /user ->用户实体集合

GET /user/1 ->实体资源user:1 .单击“确定”

说我想要一个实体user的集合和说我想要users的集合都是有效的。

GET /users ->实体用户集合

GET /users/1 ->实体用户资源:1 .单击“确定”

从这里你可以说，从用户集合中，给我user /1。

但如果你分解用户的集合……它是一个实体的集合，其中每个实体都是一个User实体。

您不会说实体是用户，因为单个数据库表通常是用户的单个记录。但是，我们这里讨论的是基于rest的服务，而不是数据库ERM。

但这只适用于名词区分清楚的用户，而且很容易掌握。然而，当一个系统中有多种相互冲突的方法时，事情就会变得非常复杂。

事实上，这两种方法在大多数情况下都是有意义的，除了少数情况下英语就像意大利面条一样。它似乎是一种迫使我们做出许多决定的语言!

简单的事实是，无论你决定什么，你的意图要一致且合乎逻辑。

在我看来，在这里和那里混合是一个糟糕的方法!这会悄悄地引入一些可以完全避免的语义歧义。

看似单一的偏好:

https://www.haproxy.com/blog/using-haproxy-as-an-api-gateway-part-1/

这里也有类似的讨论:

https://softwareengineering.stackexchange.com/questions/245202/what-is-the-argument-for-singular-nouns-in-restful-api-resource-naming

这里最重要的常数是，这似乎确实取决于某种程度的团队/公司文化偏好，根据更大的公司指南中的细节，这两种方式都有许多优点和缺点。谷歌不一定是正确的，因为它是谷歌!这适用于任何指导方针。

不要把你的头埋在沙子里，不要把你的整个理解系统松散地建立在轶事例子和观点上。

你有必要为每件事建立坚实的推理吗?如果它适合你、你的团队和你的客户，并且对新手和经验丰富的开发者(如果你是在团队环境中)有意义，那就很好。

2022-02-04 13:31:09

请参阅谷歌的API设计指南:资源名称以了解另一种命名资源的方法。

该指南要求集合以复数形式命名。

|--------------------------+---------------+-------------------+---------------+--------------|
| API Service Name         | Collection ID | Resource ID       | Collection ID | Resource ID  |
|--------------------------+---------------+-------------------+---------------+--------------|
| //mail.googleapis.com    | /users        | /name@example.com | /settings     | /customFrom  |
| //storage.googleapis.com | /buckets      | /bucket-id        | /objects      | /object-id   |
|--------------------------+---------------+-------------------+---------------+--------------|

如果你正在思考这个问题，这本书值得一读。

2019-07-03 00:58:10

对我来说，复数操作集合，而单数操作集合中的项。

集合允许使用GET / POST / DELETE方法

项允许GET / PUT / DELETE方法

例如

POST on /students将在学校增加一名新学生。

DELETE on /students将删除学校中的所有学生。

DELETE /student/123将从学校删除学生123。

这可能感觉不重要，但一些工程师有时会忘记id。如果路由总是复数并执行DELETE，可能会意外擦除数据。而在奇异点上缺少id则会返回404路由。

为了进一步扩展示例，如果API应该公开多所学校，那么如下所示

DELETE on /school/abc/students将删除学校abc中的所有学生。