一鍵生成文件
開啟apipost點選分享文件
複製並開啟文件地址就可以看到了完整的介面文件。
本節課主要是講解一些需要注意的事項。
請求引數的描述填寫
對於header、query以及form-data和urlencode的body引數，我們在如下地方填寫引數描述：
如圖中所示，對於一個填寫過的引數，我們可以在新建介面可以通過點選引數描述後面的♦️方塊標誌快速匯入描述，不用重複打字。
對於raw型別的body引數，我們可以通過點選“提取欄位和描述”來針對引數進行描述的填寫：
對於已經填寫過的引數，APIPOST會自動匹配描述，不用重複填寫。
響應引數的描述填寫
很多新手困惑為什麼APIPOST分享的文件沒有成功響應示例和錯誤響應示例，那是因為APIPOST不會把傳送後的實時響應的資料作為響應示例。
您需要手動的將實時響應結果匯入或者複製到對應的成功響應示例和錯誤響應示例。
欄位描述的填寫跟raw型別的body引數，我們可以通過點選“提取欄位和描述”來針對引數進行描述的填寫。
同樣，對於已經填寫過的引數，APIPOST會自動匹配描述，不用重複填寫。
本作品採用《CC 協議》，轉載必須註明作者和本文連結