文章詳情頁
api - Java 開發 App 接口中關于 url 和入參名稱規范的問題
瀏覽:156日期: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. ddos - apache日志很多其它網址,什么情況?2. 怎么在phpstudy中用phpexcel上傳數據到MYSQL?3. javascript - 百度搜索網站,如何讓搜索結果顯示一張圖片加上一段描述,如圖;求教4. vue.js - centos 使用vue-cli. 執行npm run dev 報錯5. php由5.3升級到5.6后,登錄網站,返回的是php代碼,不是登錄界面,各位大神有知道的嗎?6. 發現了多個名稱為[spring_web]的片段。相對順序不合法7. android - 使用vue.js進行原生開發如何進行Class綁定8. docker綁定了nginx端口 外部訪問不到9. 求救一下,用新版的phpstudy,數據庫過段時間會消失是什么情況?10. html5和Flash對抗是什么情況?
排行榜
