引言

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

創(chuàng)建接口集合

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

創(chuàng)建集合



在集合中添加接口





為接口生成樣例

上邊創(chuàng)建好請(qǐng)求之后，就可以進(jìn)行正常的請(qǐng)求了。但是，如果說接口還沒開發(fā)，先寫的文檔，也可以將規(guī)定的返回值結(jié)構(gòu)，粘貼到返回值的Body中

現(xiàn)在為接口生成一個(gè)成功的樣例



然后再生成一個(gè)失敗的樣例。同樣的方法，我們將失敗的返回值結(jié)構(gòu)粘貼到返回值Body中，然后點(diǎn)擊右上角的example，然后點(diǎn)擊Add Example

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

生成文檔

點(diǎn)擊View in web即可。生成的文檔的樣子如下:

右側(cè)的的下拉可以選擇成功或失敗時(shí)的返回值結(jié)構(gòu)

了解了如何生成文檔，那如何創(chuàng)建一個(gè)團(tuán)隊(duì)，允許團(tuán)隊(duì)成員進(jìn)行接口文檔的操作也是十分重要的

創(chuàng)建團(tuán)隊(duì)

創(chuàng)建團(tuán)隊(duì)

創(chuàng)建完成之后，進(jìn)入團(tuán)隊(duì)空間



添加集合

創(chuàng)建完空間之后，可以向空間中添加集合或API

此時(shí)便可以在該空間下添加的集合，點(diǎn)擊集合名稱即可進(jìn)入到文檔頁

說完了如何添加集合，下邊看一下如何往團(tuán)隊(duì)中添加成員

添加成員

首先進(jìn)入到團(tuán)隊(duì)管理中

然后點(diǎn)擊右側(cè)的Invite Users，會(huì)進(jìn)入邀請(qǐng)成員的頁面

邀請(qǐng)之后，對(duì)方同意之后，便可以在團(tuán)隊(duì)管理中看到成員(團(tuán)隊(duì)最多5個(gè)人)

之后想共同管理接口文檔，只需要訪問創(chuàng)建團(tuán)隊(duì)時(shí)，生成的url，即可對(duì)文檔進(jìn)行管理。雖然不像swagger和Yapi那樣功能強(qiáng)大，但是對(duì)開發(fā)一個(gè)小項(xiàng)目來說，還是夠用的

總結(jié)

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

如果覺得生活随笔網(wǎng)站內(nèi)容還不錯(cuò)，歡迎將生活随笔推薦給好友。