聲明
之前寫過(guò)關(guān)于app后端開(kāi)發(fā)的一系列文章，那是我第一次做app后端開(kāi)發(fā)，存在很多不足，本想好好修改一下，想想還是重新寫吧，這樣子也能讓我博客文章看起來(lái)多一點(diǎn)嘛，萬(wàn)一以后找工作，別人一看我博客這么多內(nèi)容，是不是很屌？
這次文章先從構(gòu)建resetful風(fēng)格的api文檔工具開(kāi)始。沒(méi)有一個(gè)好的文檔工具，在app前端人員開(kāi)發(fā)過(guò)程中會(huì)導(dǎo)致開(kāi)發(fā)效率極低，而且時(shí)不時(shí)的，他們就來(lái)找你跟他們斷點(diǎn)一下。
我的文檔經(jīng)歷
這里先不討論我的數(shù)據(jù)傳輸是否合理，僅僅以這些數(shù)據(jù)作為一個(gè)演示。后面會(huì)有專門的章節(jié)進(jìn)行app數(shù)據(jù)傳輸加密的講解。
- 在我第一次開(kāi)發(fā)app后端的時(shí)候，使用的word文檔，就是我先將所有數(shù)據(jù)格式定義好，會(huì)返回什么樣的數(shù)據(jù)寫好。前端人員照這個(gè)來(lái)進(jìn)行開(kāi)發(fā)。貼一張圖吧：
PS:存在的問(wèn)題：①接口改動(dòng)時(shí)，不易被識(shí)別。②維護(hù)困難，不便于查找。③前端開(kāi)發(fā)不能進(jìn)行測(cè)試。(如果還要寫缺點(diǎn)，有5K+字可以寫出來(lái)，就省略了哈)
- 在我開(kāi)發(fā)第二個(gè)APP的后端時(shí)，先自己寫了一個(gè)簡(jiǎn)易的app接口管理系統(tǒng)，用來(lái)后端發(fā)布接口，以及前端人員查看。效果如圖：
PS:優(yōu)點(diǎn)：①如果有多個(gè)前端人員，可以保證大家看到的是同一份文檔。②通過(guò)接口的版本標(biāo)識(shí)，方便大家查看是否修改，優(yōu)點(diǎn)等等省略。缺點(diǎn)：①不能夠進(jìn)行在線接口測(cè)試，需要借助poster插件。
- 現(xiàn)在給大家要推薦下我利用一天時(shí)間改造的swagger-ui的中文版了。本來(lái)英文就非常好了，只是為了了解一下這個(gè)東東，順手給他改成中文版了，也做為自己第一個(gè)github的項(xiàng)目吧。還是先上效果圖吧：
接口模塊界面：
接口列表界面：
某個(gè)接口界面：
|
