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


以下是我最初的想法:

camelCase

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

连字符

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

下划线

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

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


当前回答

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

什么都没有

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

其他回答

简短的回答:

用连字符作为分隔符的小写单词

长一点的回答:

URL的目的是什么?

如果指向一个地址是答案,那么一个缩短的URL也是一个很好的工作。如果我们不能让它易于阅读和维护,它就不能帮助开发人员和维护人员。它们表示服务器上的一个实体,因此必须按逻辑命名。

谷歌建议使用连字符

考虑在url中使用标点符号。网址http://www.example.com/green-dress.html比http://www.example.com/greendress.html对我们更有用。我们建议您在url中使用连字符(-)而不是下划线(_)。

从编程背景来看,camelCase是命名连词的流行选择。

但是RFC 3986将URL定义为URL的不同部分区分大小写。 由于url是大小写敏感的,所以保持低调(小写)总是安全的,并且被认为是一个很好的标准。那就把骆驼箱扔出窗外了。

来源:https://metamug.com/article/rest-api-naming-best-practices.html word-delimiters

我们应该在网页URL中使用连字符来说服搜索引擎分别索引URL中的每个关键字。

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也是

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

什么都没有

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

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

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

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