接口文檔生成詳細(xì)教程

接口文檔是一個(gè)項(xiàng)目開發(fā)中必需的說明文檔，但時(shí)接口文檔編寫起來比較費(fèi)事費(fèi)力。本文為大家推薦一款特別好用的接口文檔生成工具--apipost

apipost是一款國(guó)產(chǎn)的接口測(cè)試和接口文檔生成的工具。其中它接口文檔生成的功能特別強(qiáng)大。

打開apipost編寫一個(gè)登錄的接口請(qǐng)求

它這里有兩個(gè)功能，成功響應(yīng)示例及文檔和錯(cuò)誤響應(yīng)示例及文檔

成功響應(yīng)示例文檔，我們點(diǎn)擊從現(xiàn)有響應(yīng)結(jié)果導(dǎo)入和導(dǎo)出字段，獲得如圖效果

分享文檔查看

還可以添加錯(cuò)誤響應(yīng)示例文檔

分享查看，成功和失敗的響應(yīng)示例都會(huì)出現(xiàn)

它還支持html、markdown和word格式的接口文檔

看一下word格式的接口文檔效果（word只生成成功響應(yīng)示例文檔）

這就是apipost生成接口文檔的具體流程了

工具下載地址：https://www.apipost.cn