RESTful API资源命名中单数名词的论点是什么?


12

我知道在命名RESTful URI时,通常使用复数形式表示资源集合。我对使用单数名词的说法感到好奇。


也许是因为不是所有的东西都是收藏吗?
jwenting

那不是单例资源发挥作用​​的地方吗?
慈善机构

Answers:


12

一些资源仅包含一个项目。很好的例子就是不需要ID即可呈现要呈现的数据的所有内容。例如,非常常见的是登录资源。您(从用户和浏览器视图)只有一个登录名。您可以创建它,也可以销毁它,但是您将没有带有几个登录名的索引动作可供选择。

类似的示例可能是一些主要是静态的页面,例如公司信息,烙印,联系表格以及仅显示单个项目或仅允许单个创建操作的类似内容。

如果使用单数名词确实增加了代码的可读性,可能是一个讨论问题。


5

因为:

  1. 在开发API时,最好不要想到像“樱桃”这样的英语复数规则,尤其是当英语不是您的母语时。
  2. 有时您想从模型生成端点,该端点通常是单个的。上面的方法不能很好地发挥作用。
  3. 参数“通常您开始通过Get来查询以显示列表”并不涉及任何实际用例。这样,您最终查询的单个项目将多达甚至超过一个项目列表。
By using our site, you acknowledge that you have read and understand our Cookie Policy and Privacy Policy.
Licensed under cc by-sa 3.0 with attribution required.