1、爲何要寫接口文檔？
- 正規的團隊合做或者是項目對接，接口文檔是很是重要的，通常接口文檔都是經過開發人員寫的。一個工整的文檔顯得是非重要。
- 項目開發過程當中先後端工程師有一個統一的文件進行溝通交流開發，項目維護中或者項目人員更迭，方便後期人員查看、維護
2、接口文檔的格式json
接口主要分爲四部分：方法、uri、請求參數、返回參數後端
3、接口文檔生成工具api
apipost一款很不錯的接口測試工具，它能夠生成各類格式的接口文檔，有在線版的，markdown格式和word格式的接口文檔。瀏覽器
點擊分享當前接口markdown
分享工具
複製連接在瀏覽器中打開post
下載其餘格式的接口文檔測試
word格式的接口文檔（word只支持json格式的排版，因此百度放回的數據格式在word中顯示不規範）spa
單個接口的word格式的接口文檔能夠免費下載，下載多個簡單文檔和一個項目的接口文檔的時間就須要開會員了。3d
還有就是apipost下載多個word格式的接口文檔的時候，每一個接口是單獨的接口文檔須要合併。wps和office裏面都有合併功能。
在插入中的對象中找到文件中的文字而後點擊選擇全部接口就能夠合併了。
這就是接口文檔生成工具apipost