api - Java 開發(fā) App 接口中關(guān)于 url 和入?yún)⒚Q規(guī)范的問題
問題描述
現(xiàn)在公司用開發(fā)給前端用的接口,語言是Java,現(xiàn)在想定開發(fā)規(guī)范,然后有些糾結(jié)的地方:
一個是接口的名稱,之前用的的駝峰的形式,比如myTopic,但是看網(wǎng)上推薦的有my_topic,更容易辨識,或者推薦比較多的my-topic,看到說法是比前一種輸入起來更方便。
還有個入?yún)⒌膯栴},比如一個接口接受的參數(shù)是分頁的頁數(shù),之前也是習(xí)慣性的駝峰的pageNum,但看很多公司,比如支付寶的接受參數(shù)都是page_num這種。
想問下大家以上兩個問題一般用的是那種或推薦哪種?
問題解答
回答1:各個公司都有不同的寫法,甚至一個公司內(nèi)不同的團隊都會有不同的寫法。
但總有一種大多數(shù)時候是對的的寫法,那就是駝峰。
駝峰寫法也被實驗驗證過,最容易讓人識別,且識別速度快。可以看這里駝峰可讀性的研究
回答2:個人覺得所謂的規(guī)范 就是你們前后端的約定,約定好了,能滿足需求,那么這個約定就是你們的規(guī)范。
回答3:第一種https://img.hacpai.com/file/2...
回答4:風(fēng)格問題沒有標(biāo)準(zhǔn)答案,你列舉的3種方式都能找到案例。
我個人用的是下劃線方式 page_num這種,這種的可讀性更好,都使用小寫字母,比較適合url/uri。
回答5:建議采用豆瓣的URL的設(shè)計 http://www.prower.cn/interact...
相關(guān)文章:
1. Python中使用超長的List導(dǎo)致內(nèi)存占用過大2. 實現(xiàn)bing搜索工具urlAPI提交3. python - Django有哪些成功項目?4. Python從URL中提取域名5. MySQL主鍵沖突時的更新操作和替換操作在功能上有什么差別(如圖)6. 關(guān)于mysql聯(lián)合查詢一對多的顯示結(jié)果問題7. node.js - windows10下的npm全局路徑的復(fù)原或者將npm徹底刪除?8. 數(shù)據(jù)庫 - Mysql的存儲過程真的是個坑!求助下面的存儲過程哪里錯啦,實在是找不到哪里的問題了。9. 直接打字符不可以嗎?>和>有區(qū)別嗎10. node.js - 微信小程序websocket連接問題
