Postman官方下載文檔快速創(chuàng)建圖文教學(xué)

Postman是一款A(yù)PI 開發(fā)協(xié)作平臺，簡化構(gòu)建 API 的每個步驟并簡化協(xié)作，以便您可以更快地創(chuàng)建更好的 API。

快速創(chuàng)建自定義 API 文檔

Postman 允許您快速輕松地發(fā)布文檔。Postman 會自動提取您的示例請求、標(biāo)頭、代碼片段等，以使用動態(tài)示例和機(jī)器可讀指令填充您的文檔頁面，以便您可以輕松地與世界其他地方共享您的 API。

您可以為 Postman API 自動生成文檔。您可以私下共享您的文檔或?qū)⑵浒l(fā)布到網(wǎng)絡(luò)上。Postman 基于集合生成和托管文檔，實時同步并可通過瀏覽器訪問。您可以使用文檔與團(tuán)隊成員和合作伙伴協(xié)作，或支持開發(fā)人員采用您的公共 API。

Postman官方下載文檔快速創(chuàng)建圖文教學(xué)圖1

記錄現(xiàn)有集合

要從 Postman 生成和查看現(xiàn)有集合的文檔，請使用左側(cè)的“集合”選項卡選擇集合。選擇您需要記錄的集合并打開集合詳細(xì)信息。在右側(cè)，您可以從文檔選項卡創(chuàng)建文檔。

Postman官方下載文檔快速創(chuàng)建圖文教學(xué)圖2

或者，您可以選擇查看完整的館藏文檔，以在展開的視圖中創(chuàng)建和編輯您的文檔�；蛘�，使用“新建”按鈕，然后選擇“ API 文檔”。選擇Select an existing collection并單擊要查看其文檔的集合。輸入或編輯您的收藏的降價說明，然后點擊保存。

Postman官方下載文檔快速創(chuàng)建圖文教學(xué)圖3

您將看到您的文檔已發(fā)布的確認(rèn)信息，以及您可以訪問以在瀏覽器中查看它的鏈接。您可以直接在文檔頁面上進(jìn)行其他編輯——您會在懸停時看到可編輯區(qū)域突出顯示。單擊以進(jìn)行編輯、更改并保存它們以更新文本。

Postman官方下載文檔快速創(chuàng)建圖文教學(xué)圖4

您還可以從Web 儀表板查看文檔 -選擇查看所有集合，然后選擇一個集合以在瀏覽器中查看其文檔。默認(rèn)情況下，您的文檔是私有的，因此只有與您共享該集合的人才能看到它。您可以發(fā)布文檔以供公眾查看。

默認(rèn)情況下，您的文檔中包含一些詳細(xì)信息，您可以選擇添加更多詳細(xì)信息。

為新集合創(chuàng)建文檔

您可以從 Postman 啟動屏幕或使用New按鈕并選擇API Documentation 創(chuàng)建文檔。默認(rèn)情況下將選擇創(chuàng)建新集合。添加您想要在新集合中記錄的任何初始請求，然后單擊下一步。

Postman官方下載文檔快速創(chuàng)建圖文教學(xué)圖5

為集合命名，輸入要在您的文檔中顯示的降價說明，然后點擊保存。您將看到您的文檔已發(fā)布的確認(rèn)信息，以及您可以訪問以在瀏覽器中查看它的鏈接。

Postman官方下載文檔快速創(chuàng)建圖文教學(xué)圖6