介面文件是一個專案開發中必需的說明文件,但時介面文件編寫起來比較費事費力。本文為大家推薦一款特別好用的介面文件生成工具–apipost
apipost是一款國產的介面測試和介面文件生成的工具。其中它介面文件生成的功能特別強大。
開啟apipost編寫一個登入的介面請求
它這裡有兩個功能,成功響應示例及文件和錯誤響應示例及文件
成功響應示例文件,我們點選從現有響應結果匯入和匯出欄位,獲得如圖效果
分享文件檢視
還可以新增錯誤響應示例文件
分享檢視,成功和失敗的響應示例都會出現
它還支援html、markdown和word格式的介面文件
看一下word格式的介面文件效果(word只生成成功響應示例文件)
這就是apipost生成介面文件的具體流程了
工具下載地址:
本作品採用《CC 協議》,轉載必須註明作者和本文連結