有没有REST api的命名规范指南?

在创建REST API时，API内的命名约定是否有任何指导方针或事实上的标准(例如:URL端点路径组件，查询字符串参数)?驼色大写，还是下划线?其他人呢?

例如:

api.service.com/helloWorld/userId/x

api.service.com/hello_world/user_id/x

注意:这不是RESTful API设计的问题，而是用于最终路径组件和/或所使用的查询字符串参数的命名约定指南。

任何指导方针将不胜感激。

当前回答

我认为在REST url中尽可能少地使用特殊字符是可取的。REST的好处之一是它使服务的“接口”易于阅读。Camel格式或Pascal格式可能适合于资源名称(Users或Users)。我不认为REST有什么严格的标准。

另外，我认为甘道夫是对的，在REST中不使用查询字符串参数通常更干净，而是创建定义你想要处理哪些资源的路径。

http://api.example.com/HelloWorld/Users/12345/Order/3/etc

其他回答

域名不区分大小写，但URI的其余部分肯定可以。假设uri不区分大小写是一个很大的错误。

不。REST与URI命名约定无关。如果您将这些约定作为API的一部分包含在带外，而不是通过超文本，那么您的API就不是RESTful的。

欲了解更多信息，请参见http://roy.gbiv.com/untangled/2008/rest-apis-must-be-hypertext-driven

Dropbox、Twitter、谷歌Web Services和Facebook的REST API都使用下划线。

我在http://soaprobe.blogspot.co.uk/2012/10/soa-rest-service-naming-guideline.html上有一份我们在prod中使用的指南清单。指南总是有争议的…我认为一致性有时比把事情做到完美更重要(如果有的话)。

我觉得你应该避免戴驼峰帽。标准是使用小写字母。我还会避免使用下划线，而是使用破折号

所以你的URL应该是这样的(忽略你所要求的设计问题:-))

api.service.com/hello-world/user-id/x

推荐文章