請(qǐng)求參數(shù)的描述填寫(xiě)
對(duì)于header叫编、query以及form-data和urlencode的body參數(shù)埃难，我們?cè)谌缦碌胤教顚?xiě)參數(shù)描述：
如圖中所示银还，對(duì)于一個(gè)填寫(xiě)過(guò)的參數(shù)努隙，我們可以在新建接口可以通過(guò)點(diǎn)擊參數(shù)描述后面的??方塊標(biāo)志快速導(dǎo)入描述樱哼，不用重復(fù)打字哀九。 對(duì)于raw類(lèi)型的body參數(shù)，我們可以通過(guò)點(diǎn)擊“提取字段和描述”來(lái)針對(duì)參數(shù)進(jìn)行描述的填寫(xiě)：對(duì)于已經(jīng)填寫(xiě)過(guò)的參數(shù)搅幅，Apipost會(huì)自動(dòng)匹配描述阅束，不用重復(fù)填寫(xiě)。
響應(yīng)參數(shù)的描述填寫(xiě)
很多新手困惑為什么Apipost分享的文檔沒(méi)有成功響應(yīng)示例和錯(cuò)誤響應(yīng)示例茄唐，那是因?yàn)锳pipost不會(huì)把發(fā)送后的實(shí)時(shí)響應(yīng)的數(shù)據(jù)作為響應(yīng)示例息裸。
您需要手動(dòng)的將實(shí)時(shí)響應(yīng)結(jié)果導(dǎo)入或者復(fù)制到對(duì)應(yīng)的成功響應(yīng)示例和錯(cuò)誤響應(yīng)示例。
字段描述的填寫(xiě)跟raw類(lèi)型的body參數(shù)沪编，我們可以通過(guò)點(diǎn)擊“提取字段和描述”來(lái)針對(duì)參數(shù)進(jìn)行描述的填寫(xiě)呼盆。
同樣，對(duì)于已經(jīng)填寫(xiě)過(guò)的參數(shù)蚁廓，Apipost會(huì)自動(dòng)匹配描述访圃，不用重復(fù)填寫(xiě)。
參數(shù)描述庫(kù)的使用
填寫(xiě)參數(shù)描述是我們最煩惱的一件事情相嵌，尤其對(duì)于很多接口來(lái)說(shuō)腿时，往往具有大量相同名稱(chēng)、相同意義的參數(shù)饭宾，假如每次都需要手動(dòng)錄入批糟，將會(huì)是一件非常耗時(shí)、低效的事情捏雌。
我們可以通過(guò)參數(shù)描述庫(kù)解決這個(gè)問(wèn)題跃赚。
通過(guò)自定義參數(shù)描述庫(kù)，我們可以將本項(xiàng)目用到的大量參數(shù)進(jìn)行預(yù)注釋?zhuān)?/p>
我們也可以通過(guò)導(dǎo)入?yún)?shù)描述功能，將數(shù)據(jù)庫(kù)定義的字段注釋快速導(dǎo)入到Apipost的參數(shù)描述庫(kù)中纬傲。
