快速生成接口文檔的神器

發(fā)送 HTTP 請求

API 界面功能布局

API 請求參數(shù)

Header 參數(shù)：你可以設置或者導入 Header 參數(shù)，cookie也在Header進行設置

Query 參數(shù)：Query 支持構(gòu)造URL參數(shù)，同時支持 RESTful 的 PATH 參數(shù)（如:id）

Body 參數(shù)

Body 提供三種類型 form-data / x-www-form-urlencoded / raw ，每種類型提供三種不同的UI界面

1）當你需要提交表單時，切換到 x-www-form-urlencoded

2）當你需要提交有文件的表單時，切換到 form-data

3）當您需要發(fā)送JSON對象或者其他對象時，切換到對應的raw類型即可

API 請求響

應點擊發(fā)送按鈕后，如果有數(shù)據(jù)返回，則會顯示返回數(shù)據(jù)，響應時間，響應碼，Cookie等。

注意：返回數(shù)據(jù)默認是Pretty模式，便于查看 JSON XML 格式。您可以通過切換 原生 或 預覽 模式 查看其它類型的類型。

點擊分享文檔

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

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

請求參數(shù)的描述填寫

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

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

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

對于已經(jīng)填寫過的參數(shù)，APIPOST會自動匹配描述，不用重復填寫。

響應參數(shù)的描述填寫

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

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

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

同樣，對于已經(jīng)填寫過的參數(shù)，APIPOST會自動匹配描述，不用重復填寫。

來源：blog.csdn.net/weixin_44159454/article/details/119613271

---