聲明

之前寫過關于app后端開發(fā)的一系列文章，那是我第一次做app后端開發(fā)，存在很多不足，本想好好修改一下，想想還是重新寫吧，這樣子也能讓我博客文章看起來多一點嘛，萬一以后找工作，別人一看我博客這么多內容，是不是很屌？
這次文章先從構建resetful風格的api文檔工具開始。沒有一個好的文檔工具，在app前端人員開發(fā)過程中會導致開發(fā)效率極低，而且時不時的，他們就來找你跟他們斷點一下。

我的文檔經歷

這里先不討論我的數(shù)據傳輸是否合理，僅僅以這些數(shù)據作為一個演示。后面會有專門的章節(jié)進行app數(shù)據傳輸加密的講解。

1. 在我第一次開發(fā)app后端的時候，使用的word文檔，就是我先將所有數(shù)據格式定義好，會返回什么樣的數(shù)據寫好。前端人員照這個來進行開發(fā)。貼一張圖吧：
   
   
   
   PS:存在的問題：①接口改動時，不易被識別。②維護困難，不便于查找。③前端開發(fā)不能進行測試。(如果還要寫缺點，有5K+字可以寫出來，就省略了哈)
2. 在我開發(fā)第二個APP的后端時，先自己寫了一個簡易的app接口管理系統(tǒng)，用來后端發(fā)布接口，以及前端人員查看。效果如圖：
   
   
   
   PS:優(yōu)點：①如果有多個前端人員，可以保證大家看到的是同一份文檔。②通過接口的版本標識，方便大家查看是否修改，優(yōu)點等等省略。缺點：①不能夠進行在線接口測試，需要借助poster插件。
3. 現(xiàn)在給大家要推薦下我利用一天時間改造的swagger-ui的中文版了。本來英文就非常好了，只是為了了解一下這個東東，順手給他改成中文版了，也做為自己第一個github的項目吧。還是先上效果圖吧：
   接口模塊界面：
   
   
   
   接口列表界面：
   
   
   
   某個接口界面：