如何快速方便的生成好看的接口文檔(apipost生成文檔)

一鍵生成文檔

我們在“2分鐘玩轉APIPOST”一講中，簡單介紹了如何生成并分享接口文檔：

點擊分享文檔

復制并打開文檔地址就可以看到了完整的接口文檔。

本節課主要是講解一些需要注意的事項。

請求參數的描述填寫

對于header、query以及form-data和urlencode的body參數，我們在如下地方填寫參數描述：

如圖中所示，對于一個填寫過的參數，我們可以在新建接口可以通過點擊參數描述后面的??方塊標志快速導入描述，不用重復打字。

對于raw類型的body參數，我們可以通過點擊“提取字段和描述”來針對參數進行描述的填寫：

對于已經填寫過的參數，APIPOST會自動匹配描述，不用重復填寫。

響應參數的描述填寫

很多新手困惑為什么APIPOST分享的文檔沒有成功響應示例和錯誤響應示例，那是因為APIPOST不會把發送后的實時響應的數據作為響應示例。

您需要手動的將實時響應結果導入或者復制到對應的成功響應示例和錯誤響應示例。

字段描述的填寫跟raw類型的body參數，我們可以通過點擊“提取字段和描述”來針對參數進行描述的填寫。

同樣，對于已經填寫過的參數，APIPOST會自動匹配描述，不用重復填寫。

API web前端 軟件開發

版權聲明：本文內容由網絡用戶投稿，版權歸原作者所有，本站不擁有其著作權，亦不承擔相應法律責任。如果您發現本站中有涉嫌抄襲或描述失實的內容，請聯系我們jiasou666@gmail.com 處理，核實后本網站將在24小時內刪除侵權內容。

版權聲明：本文內容由網絡用戶投稿，版權歸原作者所有，本站不擁有其著作權，亦不承擔相應法律責任。如果您發現本站中有涉嫌抄襲或描述失實的內容，請聯系我們jiasou666@gmail.com 處理，核實后本網站將在24小時內刪除侵權內容。