api - Java 開(kāi)發(fā) App 接口中關(guān)于 url 和入?yún)⒚Q規(guī)范的問(wèn)題
問(wèn)題描述
現(xiàn)在公司用開(kāi)發(fā)給前端用的接口,語(yǔ)言是Java,現(xiàn)在想定開(kāi)發(fā)規(guī)范,然后有些糾結(jié)的地方:
一個(gè)是接口的名稱,之前用的的駝峰的形式,比如myTopic,但是看網(wǎng)上推薦的有my_topic,更容易辨識(shí),或者推薦比較多的my-topic,看到說(shuō)法是比前一種輸入起來(lái)更方便。
還有個(gè)入?yún)⒌膯?wèn)題,比如一個(gè)接口接受的參數(shù)是分頁(yè)的頁(yè)數(shù),之前也是習(xí)慣性的駝峰的pageNum,但看很多公司,比如支付寶的接受參數(shù)都是page_num這種。
想問(wèn)下大家以上兩個(gè)問(wèn)題一般用的是那種或推薦哪種?
問(wèn)題解答
回答1:各個(gè)公司都有不同的寫法,甚至一個(gè)公司內(nèi)不同的團(tuán)隊(duì)都會(huì)有不同的寫法。
但總有一種大多數(shù)時(shí)候是對(duì)的的寫法,那就是駝峰。
駝峰寫法也被實(shí)驗(yàn)驗(yàn)證過(guò),最容易讓人識(shí)別,且識(shí)別速度快。可以看這里駝峰可讀性的研究
回答2:個(gè)人覺(jué)得所謂的規(guī)范 就是你們前后端的約定,約定好了,能滿足需求,那么這個(gè)約定就是你們的規(guī)范。
回答3:第一種https://img.hacpai.com/file/2...
回答4:風(fēng)格問(wèn)題沒(méi)有標(biāo)準(zhǔn)答案,你列舉的3種方式都能找到案例。
我個(gè)人用的是下劃線方式 page_num這種,這種的可讀性更好,都使用小寫字母,比較適合url/uri。
回答5:建議采用豆瓣的URL的設(shè)計(jì) http://www.prower.cn/interact...
相關(guān)文章:
1. html調(diào)整想要的文字大小和位置2. angular.js - 請(qǐng)教一個(gè)關(guān)于angularjs的小問(wèn)題3. javascript - 底部組件,vue綁定class文字為什么不變色,如下代碼4. 前端 - vue2.0 使用mint-ui的mt-popup組件時(shí)怎么兼容低版本ios(7.1.2)?5. angular.js - 為什么加了 CSS3 的 transition 會(huì)導(dǎo)致 Angular 數(shù)據(jù)綁定失效?6. android - 百度地圖加載完成監(jiān)聽(tīng)7. javascript - 在iframe子頁(yè)面 通過(guò)window.parent.document打開(kāi)父頁(yè)面的modal層不能正常關(guān)閉8. javascript - 一個(gè)JS的算法,求大神解答9. javascript - 微信IOS頁(yè)面中input type=number輸入數(shù)字無(wú)法顯示,安卓顯示正常10. css3 - 寬度設(shè)置的都是百分比,為什么還是不適配移動(dòng)端?
