Postman接口測試(九):API 文檔生成

原文鏈接
參考鏈接

API 文檔生成

在服務端後臺的開發人員測試好了接口後,打算把接口的各種信息發給使用此 API 的前端的移動端人員時,往往會遇到:

要麼是用複製粘貼 -> 格式不友好 要麼是用 Postman 中截圖 -> 方便看,但是不方便獲得 API 接口和字段等文字內容 要麼是用 Postman 中導出爲 JSON -> json 文件中信息太繁雜,不利於找到所需要的信息 要麼是用文檔,比如去編寫 Markdown 文檔 -> 但後續 API 的變更需要實時同步修改文檔,也會很麻煩 這都會導致別人查看和使用 API 時很不方便。

-> 對此,Postman 提供了發佈 API

預覽和發佈 API 文檔 下面介紹 Postman 中如何預覽和發佈 API 文檔。

簡要概述步驟

  1. Collection
  2. 鼠標移動到某個 Collection,點擊 三個點
  3. Publish Docs
  4. Publish
  5. 得到 Public URL
  6. 別人打開這個 Public URL,即可查看 API 文檔

預覽 API 文檔

點擊分組右邊的大於號>

這裏寫圖片描述

如果只是預覽,比如後臺開發員自己查看 API 文檔的話,可以選擇:View in web

這裏寫圖片描述

等價於點擊Publish Docs去發佈:

這裏寫圖片描述

View in Web 後,有 Publish 的選項(見後面的截圖)

View in Web 後,會打開預覽頁面:

比如:

奶牛雲

https://documenter.getpostman.com/collection/view/669382-42273840-6237-dbae-5455-26b16f45e2b9

這裏寫圖片描述

這裏寫圖片描述

而右邊的示例代碼,也可以從默認的 cURL 換成其他的:

這裏寫圖片描述

這裏寫圖片描述

發佈 API 文檔

如果想要讓其他人能看到這個文檔,則點擊 Publish:

這裏寫圖片描述

然後會打開類似於這樣的地址:

Postman Documenter

https://documenter.getpostman.com/collection/publish?meta=Y29sbGVjdGlvbl9pZD00MjI3Mzg0MC02MjM3LWRiYWUtNTQ1NS0yNmIxNmY0NWUyYjkmb3duZXI9NjY5MzgyJmNvbGxlY3Rpb25fbmFtZT0lRTUlQTUlQjYlRTclODklOUIlRTQlQkElOTE=

這裏寫圖片描述

點擊 Publish 後,可以生成對應的公開的網頁地址:

這裏寫圖片描述

打開 API 接口文檔地址:

https://documenter.getpostman.com/view/669382/collection/77fd4RM

即可看到(和前面預覽一樣效果的 API 文檔了):

這裏寫圖片描述

如此,別人即可查看對應的 API 接口文檔。

已發佈的 API 文檔支持自動更新

後續如果自己的 API 接口修改後:

比如:

這裏寫圖片描述

這裏寫圖片描述

(後來發現,不用再去進入此預覽和發佈的流程,去更新文檔,而是 Postman 自動支持)

別人去刷新該文檔的頁面:

https://documenter.getpostman.com/view/669382/collection/77fd4RM

即可看到更新後的內容:

這裏寫圖片描述

發表評論
所有評論
還沒有人評論,想成為第一個評論的人麼? 請在上方評論欄輸入並且點擊發布.
相關文章