一鍵生成文檔

<div class="markdown-section">我們在“2分鐘玩轉APIPOST”一講中，簡單介紹了如何生成并分享接口文檔：

點選分享文檔

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

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

請求參數的描述填寫

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

如圖中所示，對于一個填寫過的參數，我們可以在建立接口可以通過點選參數描述後面的♦️方塊标志快速導入描述，不用重複打字。

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

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

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

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

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

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