Postman写接口文档
文章目录
- 参考
- 首先了解什么是postman
- 那么后端如何用postman编写接口文档,并且让前端或者其他开发人员也一起同步协作呢?
- 1. 注册登录postman
- 2. 创建项目工作区
- 3. 编写接口文档
- 4. 添加协作人(这一步也可以在创建工作区之初就操作)
- 5. 不添加协作人,也可以分享接口文档链接
- 6. 接口文档的导入与导出
参考
如何用Postman写接口文档,团队协作开发
最近为了减少对代码的侵入性,舍弃了之前一直使用的Swagger,但是showdoc写文档又比较麻烦,测试接口也不方便,于是看了一下网上的多篇关于postman写接口文档的文章,并且亲身实验后将经验结合起来在这里做个总结。
首先了解什么是postman
Postman是一个接口测试工具,在做接口测试的时候,Postman相当于一个客户端,它可以模拟用户发起的各类HTTP请求,将请求数据发送至服务端,获取对应的响应结果, 从而验证响应中的结果数据是否和预期值相匹配;并确保开发人员能够及时处理接口中的bug,进而保证产品上线之后的稳定性和安全性。
Postman提供了独立的安装包: https://www.postman.com/downloads/
那么后端如何用postman编写接口文档,并且让前端或者其他开发人员也一起同步协作呢?
4个步骤如下:
1. 注册登录postman
如果你还没有postman的账号,你需要进行注册一个:邮箱、用户名、密码;
如果已经有了账号,那么直接登录即可。
2. 创建项目工作区
登录成功后选择工作区, 默认会有两个工作区,团队式和个人式的工作区会有些许区别。 但是我们可以为某个项目创建一个新的工作区,单独为某个项目的交互服务:
3. 编写接口文档
2.1 创建了项目工作区后,则可以在这个工作区里创建一个或者多个collections且分别命名。这里的collections其实相当于对应项目的各个端:比如api端、admin端(或者可以直接当成一个功能模块)
2.2 然后在对应的collections端右键选择 “add folder” 添加文件夹(这里的文件夹相当于一个功能模块,可以看成是一个controller,比如“产品管理”, 但并不是必须的步骤。主要看个人的编码习惯,如果不分功能模块就不用建文件夹。 项目功能模块比较多需要细分,那么一个文件夹可以当作是一个模块)
2.3 接下来在功能文件夹下可以选择new Request添加请求, 进行接口url的描写:
这样就是一个接口的请求文档了,那么返回值的文档又如何描述呢?看图:
需要点击“Save Response” 选择其中的 “Save as example”, 这时候会生成一个e.g。 然后点击进入e.g,给对应的返回值添加**//注释**就可以了,记得点击保存。
这样就是一个完整清晰的接口文档了。
4. 添加协作人(这一步也可以在创建工作区之初就操作)
这一步主要是让前端或者开发人员之间共享查看该项目的接口文档
这里要注意一下:
1、首先必须在正确的项目工作区进行邀请,不然即使添加成功,对方也看不见分享的内容。
2、添加的对象必须是postman的注册账号,否则添加失败。
5. 不添加协作人,也可以分享接口文档链接
6. 接口文档的导入与导出
Postman如何导出接口的几种方法
Postman写接口文档相关推荐
- 如何用Postman写接口文档,团队协作开发
最近为了减少对代码的侵入性,舍弃了之前一直使用的Swagger,但是showdoc写文档又比较麻烦,测试接口也不方便,于是看了一下网上的多篇关于postman写接口文档的文章,并且亲身实验后将经验结合 ...
- springboot整合knife4j,从此告别手写接口文档
关于knife4j Knife4j的前身是swagger-bootstrap-ui,前身swagger-bootstrap-ui是一个纯swagger-ui的ui皮肤项目 一开始项目初衷是为了写一个增 ...
- 写java接口的文档工具_【java】适合写接口文档的工具,或者文本语法
由于后端与前端使用ajax交互,后端写接口文档变得非常有必要.以前我习惯用word写接口文档,但是最近与同事合作编写后端,word并不适合使用svn工具做同步,因为svn.git等无法自动合并word ...
- 写接口文档及生成mock数据
写接口文档及生成mock数据 在web应用开发的过程中,与前端联调时总会有一些接口,需要接口文档,在接口先行的情况下,前端不能拿到实际的接口进行开发,所以就需要mock数据. 今天搜索了下,阿里在这方 ...
- Haroopad写接口文档简介
一.所需工具:Haroopad - The next document processor 根据自己的电脑下载安装包,我的是Haroopad-v0.13.1-win-x64.msi,安装,一路next ...
- 【转】Postman 生成接口文档
引言 几个朋友想做一个前后端分离的项目,接口文档的重要性那是不言而喻的.生成接口文档的方法真的太多了,Yapi.Swagger等等.但是想公网上访问接口文档并修改的话,还得购买服务器,部署上去.穷码农 ...
- Markdown写接口文档,自动添加TOC
上回说到,用Impress.js代替PPT来做项目展示.这回换Markdown来做接口文档好了.(不敢说代替Word,只能说个人感觉更为方便)当然,还要辅之以Git,来方便版本管理. Markdown ...
- postman项目接口文档和登录步骤原理
培训内容 实训项目:非常果岭-发现模块接口测试,单接口.流程脚本编写: 使用工具:postman 培训方式 1)postman使用说明 2)项目接口文档和登录步骤原理 一.首先了解postman使用 ...
- 如何正确规范写接口文档
前言 正规的团队合作或者是项目对接,接口文档是非常重要的,一般接口文档都是通过开发人员写的.一个工整的文档显得是非重要.下面我将我看到的一篇接口文档做一个总结 开始吧!!! 接口1: 查询排重接口 接 ...
- 你还在手写接口文档?来,壹哥教你一招实现在线接口文档
我们知道,现在很多项目开发都采用了前后端分离的模式.在这种模式下,前端人员开发前端相关的功能,后端人员开发后端相关的功能.那么问题来了,前端需要调用后端实现的接口进行交互,两者之间是如何进行交互的?前 ...
最新文章
- 每天进步一点点——Linux
- conda如何添加,删除镜像channel,以及其他常见使用方法。
- 谈谈Mux与门电路的相互替换(包含实例分析)
- python---------sys.argv的作用
- Linux学习之系统编程篇:fifo
- 使用代理同步Chromium代码的心得(V2.0)
- 持续集成之 Nuget 进阶
- textview 结束后释放_等待按键释放,你的代码如何写?
- zImage内核镜像解压过程详解
- 算法之线性时间选择(最坏情况下)
- 中央企业经营管理一体化总体框架
- 《吴军-信息论40讲》摘录
- Mock 入门,分析stub . mock区别
- 你所不知道的我国交通工程早期经历了怎样的发展?
- MATLAB中fspecial函数的用法
- 2.6一个小工具的使用snipaste
- def序列化器---视图序列化反序列化
- bootStrap常用样式
- 创建mysql数据库快照_sql语句大全之创建数据库快照
- python 中的File