對於我們這些程序員和程序媛來講,最頭疼的莫過於寫文檔。
我們可都是正個八經的理工校草和理工女神,研究github、逛逛csdn、寫hello world是才我們的拿手菜,寫文檔是文科生的事情好不啦?(手動吐哇吐)
今天,教大家一個妙招:利用ApiPost一鍵、快速生成接口文檔!
媽媽再也不用擔心自己女孩紙們沒有時間過38節啦!
當女程序媛遇到問題,那就不是問題
ApiPost簡介:
ApiPost是一個支持團隊協作,並可直接生成文檔的API調試、管理工具。它支持模擬POST、GET、PUT等常見請求,是后台接口開發者或前端、接口測試人員不可多得的工具 。
如果你對ApiPost了解不多,可以戳這里:https://www.cnblogs.com/phpwechat/p/10487077.html
利用ApiPost一鍵、快速生成接口文檔:
當然,你得先下載安裝apipost谷歌拓展或者客戶端(個人建議客戶端)。
接下來介紹具體步驟。
1、我們先准備一段接口代碼用來測試。如圖:
一個簡單的測試接口
這個代碼僅僅用來demo沒啥技術含量,就是接受POST過來的2個參數,然后返回一個json。
2、接下來,具體操作如下圖(全程圖片-一看就懂):
發送結果
參數描述填寫
3、利用全局注釋功能,快速創建常見字段的描述
添加全局注釋
添加全局注釋
添加全局注釋
4、點擊頂部的文檔模式就可以查看文檔了。也可以導出為離線文檔。
查看接口文檔
導出接口文檔
嗯,好了。女神們,接口文檔也生成了,趕緊丟給前端過節去吧!……(^ _ ^)