api - Java 开发 App 接口中关于 url 和入参名称规范的问题
本文介绍了api - Java 开发 App 接口中关于 url 和入参名称规范的问题的处理方法,对大家解决问题具有一定的参考价值,需要的朋友们下面随着小编来一起学习吧!
问题描述
问 题
现在公司用开发给前端用的接口,语言是Java
,现在想定开发规范,然后有些纠结的地方:
一个是接口的名称,之前用的的驼峰的形式,比如myTopic
,但是看网上推荐的有my_topic
,更容易辨识,或者推荐比较多的my-topic
,看到说法是比前一种输入起来更方便。
还有个入参的问题,比如一个接口接受的参数是分页的页数,之前也是习惯性的驼峰的pageNum
,但看很多公司,比如支付宝的接受参数都是page_num
这种。
想问下大家以上两个问题一般用的是那种或推荐哪种?
解决方案
各个公司都有不同的写法,甚至一个公司内不同的团队都会有不同的写法。
但总有一种大多数时候是对的的写法,那就是驼峰。
驼峰写法也被实验验证过,最容易让人识别,且识别速度快。可以看这里驼峰可读性的研究
这篇关于api - Java 开发 App 接口中关于 url 和入参名称规范的问题的文章就介绍到这了,希望我们推荐的答案对大家有所帮助,也希望大家多多支持IT屋!
查看全文