天天看點

Postman----支援markdown可自動生成接口文檔

1、postman支援markdown作為集合中的請求,對集合和檔案夾進行文字描述的方式,您可以嵌入螢幕截圖和其他圖像已獲得更多描述性的介紹。

Postman----支援markdown可自動生成接口文檔

2、已markdown文法為準,填寫自己想要展示的内容

Postman----支援markdown可自動生成接口文檔

3、填寫完後看展示效果如下:

Postman----支援markdown可自動生成接口文檔

4、以上所填寫的描述,将會顯示在該集合的自動生成文檔中,檢視自動生成文檔如下截圖步驟進行操作

Postman----支援markdown可自動生成接口文檔

web頁面的展示如下:自動生成文檔中的參數

Postman----支援markdown可自動生成接口文檔

                                                                               

注意:路徑變量和URL參數的說明目前未顯示在文檔中 

Postman----支援markdown可自動生成接口文檔

  1.作者:Syw

2,本文版權歸作者所有,歡迎轉載,但未經作者同意必須保留此段聲明,且在文章頁面明顯位置給出原文連接配接,否則保留追究法律責任的權利。

繼續閱讀