在uri中，连字符、下划线或骆驼字分隔符?

我正在为一个内部网络应用程序设计一个基于http的API。我意识到这是一个非常小的问题，但是:我应该使用连字符、下划线或骆驼号来分隔uri中的单词吗?

以下是我最初的想法:

camelCase

如果服务器不区分大小写，可能会出现问题似乎在查询字符串键(http://api.example.com?**searchQuery**=…)中有相当广泛的使用，但在其他URI部分中没有

连字符

比其他选择更具美感似乎在URI的路径部分被广泛使用从来没有见过连字符的查询字符串键在野外可能对搜索引擎优化更好(这可能是一个神话)

下划线

编程语言可能更容易处理一些流行的api (Facebook, Netflix, StackExchange等)在URI的所有部分都使用下划线。

我倾向于用下划线表示所有内容。事实上，大多数大公司都在使用它们(见https://stackoverflow.com/a/608458/360570)。

当前回答

你应该在可爬行的web应用程序URL中使用连字符。为什么?因为连字符分隔单词(以便搜索引擎可以索引单个单词)，而且连字符不是单词字符。下划线是一个单词字符，这意味着它应该被认为是单词的一部分。

在Chrome中双击这个:camelCase 在Chrome中双击这个:under_score 在Chrome中双击该文件:连字符

看看Chrome(我听说谷歌也做了一个搜索引擎)只认为其中一个是两个词?

camelCase和underscore也要求用户使用shift键，而hyphenated则不需要。

所以，如果你应该在一个可爬行的web应用程序中使用连字符，为什么要在一个内部网应用程序中做一些不同的事情呢?少记一件事。

2013-08-26 18:32:22

其他回答

建议使用脊壳(突出显示为 RFC3986)，这个案例被谷歌，PayPal，和其他大公司。

来源:https://blog.restcase.com/5-basic-rest-api-design-guidelines/

编辑:虽然RFC上的重点没有找到，但关于脊柱病例的建议仍然有效(正如已经在其他答案中指出的那样)

2021-01-14 15:40:34

虽然我推荐连字符，但我也会假设一个不在你列表上的答案:

什么都没有

我公司的API有类似/quotationrequests/， /purchaseorders/等uri。尽管你说这是一个内部网应用，但你把搜索引擎优化列为一个好处。谷歌在查询?q=foo+bar时匹配URL中的/foobar/模式我真的希望您不要考虑像@ServAce85所建议的那样，对用户传递到地址栏的任意字符串执行PHP调用!

2012-12-03 15:48:22

在Chrome中双击这个:camelCase 在Chrome中双击这个:under_score 在Chrome中双击该文件:连字符

看看Chrome(我听说谷歌也做了一个搜索引擎)只认为其中一个是两个词?

camelCase和underscore也要求用户使用shift键，而hyphenated则不需要。

所以，如果你应该在一个可爬行的web应用程序中使用连字符，为什么要在一个内部网应用程序中做一些不同的事情呢?少记一件事。

2013-08-26 18:32:22

REST api的标准最佳实践是使用连字符，而不是骆驼字或下划线。

这来自Mark Masse的Oreilly的“REST API设计规则手册”。

另外，请注意Stack Overflow本身在URL中使用连字符:…/连字符下划线-or-camelcase-as-word- delimator - In -uri

http://inventwithpython.com/blog/2012/03/18/how-much-math-do-i-need-to-know-to-program-not-that-much-actually也是

2013-08-26 17:38:01

这是两全其美的东西。