小编典典

REST API 是否有任何命名约定准则?

all

在创建 REST API 时,API 内的命名约定是否有任何指南或事实上的标准(例如:URL
端点路径组件、查询字符串参数)?骆驼帽是常态还是下划线?其他的?

例如:

api.service.com/helloWorld/userId/x

或者

api.service.com/hello_world/user_id/x

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

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


阅读 70

收藏
2022-06-18

共1个答案

小编典典

我认为你应该避免戴骆驼帽。规范是使用小写字母。我也会避免使用下划线,而是使用破折号

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

api.service.com/hello-world/user-id/x
2022-06-18