Java 开发 App 接口中关于 url 和入参名称规范的问题

发布于 2022-09-04 14:36:30 字数 341 浏览 25 评论 0

现在公司用开发给前端用的接口,语言是Java,现在想定开发规范,然后有些纠结的地方:

一个是接口的名称,之前用的的驼峰的形式,比如myTopic,但是看网上推荐的有my_topic,更容易辨识,或者推荐比较多的my-topic,看到说法是比前一种输入起来更方便。

还有个入参的问题,比如一个接口接受的参数是分页的页数,之前也是习惯性的驼峰的pageNum,但看很多公司,比如支付宝的接受参数都是page_num这种。

想问下大家以上两个问题一般用的是那种或推荐哪种?

如果你对这篇内容有疑问,欢迎到本站社区发帖提问 参与讨论,获取更多帮助,或者扫码二维码加入 Web 技术交流群。

扫码二维码加入Web技术交流群

发布评论

需要 登录 才能够评论, 你可以免费 注册 一个本站的账号。

评论(5

陪你到最终 2022-09-11 14:36:30

各个公司都有不同的写法,甚至一个公司内不同的团队都会有不同的写法。

但总有一种大多数时候是对的的写法,那就是驼峰。

驼峰写法也被实验验证过,最容易让人识别,且识别速度快。可以看这里驼峰可读性的研究

梦断已成空 2022-09-11 14:36:30

个人觉得所谓的规范 就是你们前后端的约定,约定好了,能满足需求,那么这个约定就是你们的规范。

扭转时空 2022-09-11 14:36:30

风格问题没有标准答案,你列举的3种方式都能找到案例。

我个人用的是下划线方式 page_num这种,这种的可读性更好,都使用小写字母,比较适合url/uri。

请持续率性 2022-09-11 14:36:30

建议采用豆瓣的URL的设计 http://www.prower.cn/interact...

~没有更多了~
我们使用 Cookies 和其他技术来定制您的体验包括您的登录状态等。通过阅读我们的 隐私政策 了解更多相关信息。 单击 接受 或继续使用网站,即表示您同意使用 Cookies 和您的相关数据。
原文