介面文件生成詳細教程

测试人生路發表於2020-11-11

介面文件是一個專案開發中必需的說明文件,但時介面文件編寫起來比較費事費力。本文為大家推薦一款特別好用的介面文件生成工具--apipost

apipost 是一款國產的介面測試和介面文件生成的工具。其中它介面文件生成的功能特別強大。

開啟 apipost 編寫一個登入的介面請求

它這裡有兩個功能,成功響應示例及文件和錯誤響應示例及文件

成功響應示例文件,我們點選從現有響應結果匯入和匯出欄位,獲得如圖效果

分享文件檢視

還可以新增錯誤響應示例文件

分享檢視,成功和失敗的響應示例都會出現

它還支援 html、markdown 和 word 格式的介面文件

看一下 word 格式的介面文件效果(word 只生成成功響應示例文件)

這就是 apipost 生成介面文件的具體流程了

工具下載地址:https://www.apipost.cn/?dt=20201111

相關文章