api - Java 開(kāi)發(fā) App 接口中關(guān)于 url 和入?yún)⒚Q(chēng)規(guī)范的問(wèn)題
問(wèn)題描述
現(xiàn)在公司用開(kāi)發(fā)給前端用的接口,語(yǔ)言是Java,現(xiàn)在想定開(kāi)發(fā)規(guī)范,然后有些糾結(jié)的地方:
一個(gè)是接口的名稱(chēng),之前用的的駝峰的形式,比如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è)公司都有不同的寫(xiě)法,甚至一個(gè)公司內(nèi)不同的團(tuán)隊(duì)都會(huì)有不同的寫(xiě)法。
但總有一種大多數(shù)時(shí)候是對(duì)的的寫(xiě)法,那就是駝峰。
駝峰寫(xiě)法也被實(shí)驗(yàn)驗(yàn)證過(guò),最容易讓人識(shí)別,且識(shí)別速度快。可以看這里駝峰可讀性的研究
回答2:個(gè)人覺(jué)得所謂的規(guī)范 就是你們前后端的約定,約定好了,能滿(mǎn)足需求,那么這個(gè)約定就是你們的規(guī)范。
回答3:第一種https://img.hacpai.com/file/2...
回答4:風(fēng)格問(wèn)題沒(méi)有標(biāo)準(zhǔn)答案,你列舉的3種方式都能找到案例。
我個(gè)人用的是下劃線(xiàn)方式 page_num這種,這種的可讀性更好,都使用小寫(xiě)字母,比較適合url/uri。
回答5:建議采用豆瓣的URL的設(shè)計(jì) http://www.prower.cn/interact...
相關(guān)文章:
1. 運(yùn)行python程序時(shí)出現(xiàn)“應(yīng)用程序發(fā)生異常”的內(nèi)存錯(cuò)誤?2. spring-mvc - spring-session-redis HttpSessionListener失效3. javascript - QQ第三方登錄的問(wèn)題4. 在mac下出現(xiàn)了兩個(gè)docker環(huán)境5. node.js - mongodb查找子對(duì)象的名稱(chēng)為某個(gè)值的對(duì)象的方法6. 利用IPMI遠(yuǎn)程安裝centos報(bào)錯(cuò)!7. 測(cè)試自動(dòng)化html元素選擇器元素ID或DataAttribute [關(guān)閉]8. 正在使用electron和node.js做桌面應(yīng)用,需要實(shí)時(shí)監(jiān)聽(tīng)是否有網(wǎng)絡(luò)連接,node或者electron是否可以做到9. javascript - 在 model里定義的 引用表模型時(shí),model為undefined。10. java - Spring boot 讀取 放在 jar 包外的,log4j 配置文件,系統(tǒng)有創(chuàng)建日志文件,不寫(xiě)入日志信息。

網(wǎng)公網(wǎng)安備