使用Markdown進行說明
Postman支持 Markdown 作為對集合中的請求巴席，集合和文件夾進行文字描述的方式颠放。您甚至可以嵌入屏幕截圖和其他圖像以獲得更多描述性的方式即寒。
回顧Markdown參考 API文檔。
Postman在以下地方支持Markdown：
在請求構(gòu)建器中爵川，請求描述可以用Markdown來美化策添。
集合詳細信息視圖可以在集合和文件夾的描述中使用Markdown來美化。
對于公共或內(nèi)部API文檔东亦，自動生成的API描述將通過Markdown以精簡和精確的方式進行美化杏节。
請求屬性的描述
數(shù)據(jù)編輯器中的描述列使您的請求更容易理解。您可以為Postman應(yīng)用程序中的每個查詢參數(shù)典阵，路徑變量奋渔，header和body（表單數(shù)據(jù)和urlencoded）添加注釋和詳細信息。
例如壮啊，指定元素是必需的還是可選的嫉鲸，指示其接受的數(shù)據(jù)類型，或使用其他可替代的術(shù)語為正在處理您的請求的開發(fā)人員提供額外的說明歹啼。
對于Postman用戶發(fā)布內(nèi)部或公共API文檔玄渗，這些描述顯示在該集合的自動生成的文檔中。
注意：路徑變量和URL參數(shù)的說明目前未顯示在文檔中狸眼。
您可以通過單擊編輯器右上角的省略號（...）來隱藏和顯示數(shù)據(jù)編輯器中的值和描述列藤树，并取消選中要隱藏的列。
注意：描述是請求的元數(shù)據(jù)拓萌，不會與您的HTTP請求一起發(fā)送岁钓。當(dāng)您將鼠標(biāo)懸停在描述列的標(biāo)題上時，會顯示此提醒微王。
