如何生成接口文檔

接口文檔是一個項目開發中必需的說明文檔,但時接口文檔編寫起來比較費事費力。本文爲你們推薦一款特別好用的接口文檔生成工具--apipost
apipost是一款國產的接口測試和接口文檔生成的工具。其中它接口文檔生成的功能特別強大。
打開apipost編寫一個登陸的接口請求
它這裏有兩個功能,成功響應示例及文檔和錯誤響應示例及文檔
成功響應示例文檔,咱們點擊從現有響應結果導入和導出字段,得到如圖效果
 
分享文檔查看
還能夠添加錯誤響應示例文檔
分享查看,成功和失敗的響應示例都會出現
它還支持html、markdown和word格式的接口文檔
看一下word格式的接口文檔效果(word只生成成功響應示例文檔)
這就是apipost生成接口文檔的具體流程了
工具下載地址: ApiPost - www.apipost.cn
相關文章
相關標籤/搜索