Postman 生成接口文档

引言

几个朋友想做一个前后端分离的项目，接口文档的重要性那是不言而喻的。生成接口文档的方法真的太多了，Yapi、Swagger等等。但是想公网上访问接口文档并修改的话，还得购买服务器，部署上去。穷码农，哪有钱购买服务器。如果我不想购买服务器部署，又想让不在一块的前端和后台小伙伴能同时访问并修改接口文档该怎么办？postman团队背靠google，贼有钱，提供了域名和服务器，所有人都可以查看文档。并且可以创建团队，团队成员根据角色可对空间中的文档进行查看或编辑。废话不多说，上干货！(多图预警)

创建接口集合

首先要求必须登录postman才行，不然无法进行后边的生成文档操作

创建集合



在集合中添加接口





为接口生成样例

上边创建好请求之后，就可以进行正常的请求了。但是，如果说接口还没开发，先写的文档，也可以将规定的返回值结构，粘贴到返回值的Body中

现在为接口生成一个成功的样例



然后再生成一个失败的样例。同样的方法，我们将失败的返回值结构粘贴到返回值Body中，然后点击右上角的example，然后点击Add Example

异常的情况就不再举例，也是一样的方法

生成文档

点击View in web即可。生成的文档的样子如下:

右侧的的下拉可以选择成功或失败时的返回值结构

了解了如何生成文档，那如何创建一个团队，允许团队成员进行接口文档的操作也是十分重要的

创建团队

创建团队

创建完成之后，进入团队空间



添加集合

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

此时便可以在该空间下添加的集合，点击集合名称即可进入到文档页

说完了如何添加集合，下边看一下如何往团队中添加成员

添加成员

首先进入到团队管理中

然后点击右侧的Invite Users，会进入邀请成员的页面

邀请之后，对方同意之后，便可以在团队管理中看到成员(团队最多5个人)

之后想共同管理接口文档，只需要访问创建团队时，生成的url，即可对文档进行管理。虽然不像swagger和Yapi那样功能强大，但是对开发一个小项目来说，还是够用的