文章詳情頁
api - Java 開發 App 接口中關于 url 和入參名稱規范的問題
瀏覽:130日期: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 images顯示的鏡像過多,狗眼被亮瞎了,怎么辦?2. javascript - Web微信聊天輸入框解決方案3. 請教各位大佬,瀏覽器點 提交實例為什么沒有反應4. javascript - log4js的使用問題5. docker - 如何修改運行中容器的配置6. javascript - 移動端textarea不能上下滑動,該怎么解決?7. javascript - history.replaceState()無法改變query參數8. javascript - 為什么form表單提交沒有跨域問題,但ajax提交有跨域問題?9. javascript - Ajax加載Json時,移動端頁面向左上角縮小一截兒,加載完成后才正常顯示,這該如何解決?10. javascript - 為什么這個點擊事件需要點擊兩次才有效果
排行榜
