引言

幾個朋友想做一個前后端分離的項目，接口文檔的重要性那是不言而喻的。生成接口文檔的方法真的太多了，Yapi、Swagger等等。但是想公網上訪問接口文檔并修改的話，還得購買服務器，部署上去。窮碼農，哪有錢購買服務器。如果我不想購買服務器部署，又想讓不在一塊的前端和后臺小伙伴能同時訪問并修改接口文檔該怎么辦？postman團隊背靠google，賊有錢，提供了域名和服務器，所有人都可以查看文檔。并且可以創建團隊，團隊成員根據角色可對空間中的文檔進行查看或編輯。廢話不多說，上干貨！(多圖預警)

創建接口集合

首先要求必須登錄postman才行，不然無法進行后邊的生成文檔操作

創建集合



在集合中添加接口





為接口生成樣例

上邊創建好請求之后，就可以進行正常的請求了。但是，如果說接口還沒開發，先寫的文檔，也可以將規定的返回值結構，粘貼到返回值的Body中

現在為接口生成一個成功的樣例



然后再生成一個失敗的樣例。同樣的方法，我們將失敗的返回值結構粘貼到返回值Body中，然后點擊右上角的example，然后點擊Add Example

異常的情況就不再舉例，也是一樣的方法

生成文檔

點擊View in web即可。生成的文檔的樣子如下:

右側的的下拉可以選擇成功或失敗時的返回值結構

了解了如何生成文檔，那如何創建一個團隊，允許團隊成員進行接口文檔的操作也是十分重要的

創建團隊

創建團隊

創建完成之后，進入團隊空間



添加集合

創建完空間之后，可以向空間中添加集合或API

此時便可以在該空間下添加的集合，點擊集合名稱即可進入到文檔頁

說完了如何添加集合，下邊看一下如何往團隊中添加成員

添加成員

首先進入到團隊管理中

然后點擊右側的Invite Users，會進入邀請成員的頁面

邀請之后，對方同意之后，便可以在團隊管理中看到成員(團隊最多5個人)

之后想共同管理接口文檔，只需要訪問創建團隊時，生成的url，即可對文檔進行管理。雖然不像swagger和Yapi那樣功能強大，但是對開發一個小項目來說，還是夠用的

總結

以上是生活随笔為你收集整理的【转】Postman 生成接口文档的全部內容，希望文章能夠幫你解決所遇到的問題。

如果覺得生活随笔網站內容還不錯，歡迎將生活随笔推薦給好友。