api - Java 開發(fā) App 接口中關于 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ù),之前也是習慣性的駝峰的pageNum,但看很多公司,比如支付寶的接受參數(shù)都是page_num這種。
想問下大家以上兩個問題一般用的是那種或推薦哪種?
問題解答
回答1:各個公司都有不同的寫法,甚至一個公司內(nèi)不同的團隊都會有不同的寫法。
但總有一種大多數(shù)時候是對的的寫法,那就是駝峰。
駝峰寫法也被實驗驗證過,最容易讓人識別,且識別速度快。可以看這里駝峰可讀性的研究
回答2:個人覺得所謂的規(guī)范 就是你們前后端的約定,約定好了,能滿足需求,那么這個約定就是你們的規(guī)范。
回答3:第一種https://img.hacpai.com/file/2...
回答4:風格問題沒有標準答案,你列舉的3種方式都能找到案例。
我個人用的是下劃線方式 page_num這種,這種的可讀性更好,都使用小寫字母,比較適合url/uri。
回答5:建議采用豆瓣的URL的設計 http://www.prower.cn/interact...
相關文章:
1. css - chrome下a標簽嵌套img 顯示會多個小箭頭?2. sql語句 - mysql中關聯(lián)表查詢問題3. python - django models 為生成的html元素添加樣式。4. javascript - 如何將一個div始終固定在某個位置;無論屏幕和分辨率怎么變化;div位置始終不變5. javascript - vscode alt+shift+f 格式化js代碼,通不過eslint的代碼風格檢查怎么辦。。。6. javascript - 有什么比較好的網(wǎng)頁版shell前端組件?7. javascript - 原生canvas中如何獲取到觸摸事件的canvas內(nèi)坐標?8. javascript - iframe 為什么加載網(wǎng)頁的時候滾動條這樣顯示?9. html - vue項目中用到了elementUI問題10. mysql updtae追加數(shù)據(jù)sql語句
