如何用Postman写接口文档,团队协作开发 |
您所在的位置:网站首页 › postman导出api文档 › 如何用Postman写接口文档,团队协作开发 |
最近为了减少对代码的侵入性,舍弃了之前一直使用的Swagger,但是showdoc写文档又比较麻烦,测试接口也不方便,于是看了一下网上的多篇关于postman写接口文档的文章,并且亲身实验后将经验结合起来在这里做个总结。 首先了解什么是postmanPostman是一个接口测试工具,在做接口测试的时候,Postman相当于一个客户端,它可以模拟用户发起的各类HTTP请求,将请求数据发送至服务端,获取对应的响应结果, 从而验证响应中的结果数据是否和预期值相匹配;并确保开发人员能够及时处理接口中的bug,进而保证产品上线之后的稳定性和安全性。 Postman提供了独立的安装包: https://www.postman.com/downloads/ 那么后端如何用postman编写接口文档,并且让前端或者其他开发人员也一起同步协作呢? 4个步骤如下: 1. 注册登录postman如果你还没有postman的账号,你需要进行注册一个:邮箱、用户名、密码; 如果已经有了账号,那么直接登录即可。 2. 创建项目工作区登录成功后选择工作区, 默认会有两个工作区,团队式和个人式的工作区会有些许区别。 但是我们可以为某个项目创建一个新的工作区,单独为某个项目的交互服务: 2.1 创建了项目工作区后,则可以在这个工作区里创建一个或者多个collections且分别命名。这里的collections其实相当于对应项目的各个端:比如api端、admin端(或者可以直接当成一个功能模块) 这一步主要是让前端或者开发人员之间共享查看该项目的接口文档 postman中还可以根据开发需要移除协作人或者给协作人修改权限等,这个可以个人去摸索。 小白小记,有错误的地方还望各位大佬指正! |
今日新闻 |
推荐新闻 |
CopyRight 2018-2019 办公设备维修网 版权所有 豫ICP备15022753号-3 |