文章详情页
api - Java 开发 App 接口中关于 url 和入参名称规范的问题
浏览：255日期：2024-02-06 09:14:10
问题描述
现在公司用开发给前端用的接口，语言是Java，现在想定开发规范，然后有些纠结的地方：
一个是接口的名称，之前用的的驼峰的形式，比如myTopic，但是看网上推荐的有my_topic，更容易辨识，或者推荐比较多的my-topic，看到说法是比前一种输入起来更方便。
还有个入参的问题，比如一个接口接受的参数是分页的页数，之前也是习惯性的驼峰的pageNum，但看很多公司，比如支付宝的接受参数都是page_num这种。
想问下大家以上两个问题一般用的是那种或推荐哪种？
问题解答
回答1：各个公司都有不同的写法，甚至一个公司内不同的团队都会有不同的写法。
但总有一种大多数时候是对的的写法，那就是驼峰。
驼峰写法也被实验验证过，最容易让人识别，且识别速度快。可以看这里驼峰可读性的研究
回答2：个人觉得所谓的规范 就是你们前后端的约定，约定好了，能满足需求，那么这个约定就是你们的规范。
回答3：第一种https://img.hacpai.com/file/2...
回答4：风格问题没有标准答案，你列举的3种方式都能找到案例。
我个人用的是下划线方式 page_num这种，这种的可读性更好，都使用小写字母，比较适合url/uri。
回答5：建议采用豆瓣的URL的设计 http://www.prower.cn/interact...
标签：
java
相关文章：
1. docker镜像push报错2. 如何解决Centos下Docker服务启动无响应，且输入docker命令无响应？3. docker images显示的镜像过多，狗眼被亮瞎了，怎么办？4. 如何解决docker宿主机无法访问容器中的服务？5. docker api 开发的端口怎么获取？6. android glide asbitmap 在baseadpter中的问题7. 老师，flex-shrink: 1; 按视频操作，不会自动缩放8. python - 字符串里的u’u00a1’怎么打印成中文9. python - 怎样在linux下开发flask web应用时查看代码出错（traceback）的地方。10. PHP中的$this代表当前的类还是方法？
排行榜
网公网安备