Postman工作协同:生成接口文档和示例,超实用

这篇具有很好参考价值的文章主要介绍了Postman工作协同:生成接口文档和示例,超实用。希望对大家有所帮助。如果存在错误或未考虑完全的地方,请大家不吝赐教,您也可以点击"举报违法"按钮提交疑问。

postman生成api文档,自动化测试,软件测试,技术分享,postman,单元测试,压力测试,python,程序人生

Postman这个Documentation功能对于前后端分离的团队,接口开发团队来说真的是提升沟通效率和工作效率的一个利器。废话不多说,直接上干货来看如何通过Postman来生成接口文档和发布接口文档,以及如何定制化文档中的内容。

流程概要:

定义一套接口,为接口生成文档和示例一般来说有以下步骤:(这里只列出postman参与的部分)

创建一个接口集合,描述该接口集合的功能、范围等信息

  • 将所有需求已清晰的接口定义到集合当中

  • 创建接口(add request),描述该接口的作用

  • 为该接口上的所有参数增加描述信息(params, header, body)

  • 为接口生成样例

  • 成功样例

  • 失败样例

  • 异常样例

  • 重复前两个步骤,完成接口集中的接口定义

  • 创建文档

接下来,以elasticsearch 的Restful API 接口作为一个示例,来展示如何用Postman生成接口文档和示例;

创建接口集合

假设,我们要开发elasticsearch的增删改查服务,并且已经在团队内对接口达成了共识,并将为其创建可维护的文档。

postman生成api文档,自动化测试,软件测试,技术分享,postman,单元测试,压力测试,python,程序人生

创建接口(add request),描述该接口的作用

如上文提到,我们有4个接口,增,删,改,查,可对elasticsearch中的索引进行对应操作。首先,让我们添加一个create文档的接口。并添加对接口对简单描述:

postman生成api文档,自动化测试,软件测试,技术分享,postman,单元测试,压力测试,python,程序人生

为该接口上的所有参数增加描述信息(params, header, body)

填入接口的细节:

postman生成api文档,自动化测试,软件测试,技术分享,postman,单元测试,压力测试,python,程序人生

postman生成api文档,自动化测试,软件测试,技术分享,postman,单元测试,压力测试,python,程序人生

为接口生成样例

成功样例:

在创建样例的时候,我们可以根据约定好的返回内容,填充到样例中(example)。

postman生成api文档,自动化测试,软件测试,技术分享,postman,单元测试,压力测试,python,程序人生

在接口已经开发好的情况下,我们还可以点击send按钮,直接将接口的response保存为样例:

postman生成api文档,自动化测试,软件测试,技术分享,postman,单元测试,压力测试,python,程序人生

我们还可以创建一个稍微复杂的样例,比如列出接口上可用的参数:

postman生成api文档,自动化测试,软件测试,技术分享,postman,单元测试,压力测试,python,程序人生

失败样例:

同样,我们可以保存一个失败的样例,比如,当date类型的值,被输入一个字符串的时候,接口将会报错。

postman生成api文档,自动化测试,软件测试,技术分享,postman,单元测试,压力测试,python,程序人生

异常样例:

我们可以类比之前的两个样例,依葫芦画瓢,这里就不再重复。

创建并查看文档

在将接口都创建到集合之后,我们就可以创建文档了,具体的方法很简单,在集合的选项中,点击view in web,即可看到创建的文档,以及文档中的示例:

发布文档

在接口经过数轮的修改,可以发布之后,我们也可以发布接口文档了。这里,postman团队背靠google是很有钱的,它提供了域名和服务器为我们存储在互联网上发布所有人都可以查看的文档:

postman生成api文档,自动化测试,软件测试,技术分享,postman,单元测试,压力测试,python,程序人生

根据接口示例创建mock服务

这个mock server仍然是postman团队为我们提供的域名和服务器,因为我们在创建接口文档的过程中,已经创建了各种样例,所以,我们是可以直接生成mock server,而不需要额外的工作的。

绵薄之力
最后感谢每一个认真阅读我文章的人,看着粉丝一路的上涨和关注,礼尚往来总是要有的,虽然不是什么很值钱的东西,如果你用得到的话可以直接拿走:

postman生成api文档,自动化测试,软件测试,技术分享,postman,单元测试,压力测试,python,程序人生

这些资料,对于想学习【软件测试】的朋友来说应该是最全面最完整的备战仓库,这个仓库也陪伴我走过了最艰难的路程,希望也能帮助到你!凡事要趁早,特别是技术行业,一定要提升技术功底。希望对大家有所帮助…… 零基础-功能-接口-自动化-性能-测试开发-面试_爱学习的潇潇的博客-CSDN博客零基础-功能-接口-自动化-性能-测试开发-面试 文档获取方式:这份文档和视频资料,对于想从事【软件测试】的朋友来说应该是最全面最完整的备战仓库,这个仓库也陪伴我走过了最艰难的路程,希望也能帮助到你!以上均可以分享,点下方进群自行领取即可,拿走不谢。https://blog.csdn.net/nhb687095/article/details/129667786?spm=1001.2014.3001.5501文章来源地址https://www.toymoban.com/news/detail-626876.html

到了这里,关于Postman工作协同:生成接口文档和示例,超实用的文章就介绍完了。如果您还想了解更多内容,请在右上角搜索TOY模板网以前的文章或继续浏览下面的相关文章,希望大家以后多多支持TOY模板网!

本文来自互联网用户投稿,该文观点仅代表作者本人,不代表本站立场。本站仅提供信息存储空间服务,不拥有所有权,不承担相关法律责任。如若转载,请注明出处: 如若内容造成侵权/违法违规/事实不符,请点击违法举报进行投诉反馈,一经查实,立即删除!

领支付宝红包 赞助服务器费用

相关文章

  • swagger接口文档导入postman

    第一步:打开接口文档并且打开控制台: 第二步:点击Network,找到api-docs的文件  第三步:将JSON格式的数据保存到本地  第四步:打开Postman,并且点击右上角的Import  第五步:将刚才的JSON格式数据粘贴复制到Raw Text  第六步:点击Continue,执行POSTman的默认选项,并且点击

    2024年02月13日
    浏览(48)
  • postman导入json格式的接口文档

    Download Postman | Get Started for Free   点击下载,等待下载完成即可 双击安装,等带安装完成 注意:这个功能必须登录才能使用 1. 点击import 2. 点击files,弹窗选择文件   选择后缀是json的文件即可    最终的效果如上图 接下来就可以掉调用接口了

    2024年02月15日
    浏览(47)
  • API接口文档利器:Swagger 和 接口调试利器:Postman

    2.1.1Swagger介绍 Swagger 是一个规范和完整的框架,用于生成、描述、调用和可视化 RESTful 风格的 Web 服务 (https://swagger.io/)。 它的主要作用是: 使得前后端分离开发更加方便,有利于团队协作 接口的文档在线自动生成,降低后端开发人员编写接口文档的负担 功能测试 Spring已经

    2024年02月11日
    浏览(43)
  • 全网最牛最全的Postman接口测试工具 接口自动化测试最全实用教程

    温馨提醒:本文超过10000+字,适用测试工程师入门postman工具进行接口测试,建议收藏慢慢看~~ 视频教程:年入58w的测试开发讲解的全套postman接口测试 接口自动化测试全套教程_哔哩哔哩_bilibili     1、postman的特点 postman只做 http协议 的接口的测试,是一种最广泛REST接口测试客

    2024年02月16日
    浏览(57)
  • Restful风格使用postman测试接口【增删查改示例】

    Postman 最早是google的一个插件存在的,但是又google退出中国以及postman团队对工具的定位,主攻pc端app的开发及优化,现在的google插件已经很少再使用了,postman虽然是一个商用软件,但是对于我们普通用户来说,基本功能完全够用的。 Postman 从最初设计上就是为接口测试而生的

    2024年02月06日
    浏览(56)
  • Spring 6.0官方文档示例(22): singleton类型的bean和prototype类型的bean协同工作的方法(一)

    一、配置文件: 二、实体类 三、主类:

    2024年02月15日
    浏览(36)
  • Spring 6.0官方文档示例(23): singleton类型的bean和prototype类型的bean协同工作的方法(二)

    使用lookup-method: 一、实体类: 二、配置文件: 三、主类:

    2024年02月15日
    浏览(35)
  • 使用Postman做接口测试并生成接口测试报告

    1、录制脚本或使用手写url进行抓包 2、微信api接口(可录制可手写) 3、添加多 个标签,获取多个标签,编辑多个标签,删除多个标签!!!(csv格式) 4、通过cli命令行方式执行脚本并生成报告 一 、添加标签 1、首先进入微信公众号开放测试端口,复制url到postman,用post请

    2023年04月08日
    浏览(44)
  • 接口测试(二)—— Postman用法详解、newman生成测试报告

    其他 接口自动化测试 知识参考:接口自动化测试 目录 一、Postman介绍和安装 1、简介 2、安装 3、安装Postman插件newman  二、Postman基本用法 1、案例一 2、案例二 三、Postman高级用法 1、管理测试用例Collections 1.1、创建 collections 1.2、创建 用例集、子目录和 请求 2、用例集导出、

    2023年04月11日
    浏览(45)

觉得文章有用就打赏一下文章作者

支付宝扫一扫打赏

博客赞助

微信扫一扫打赏

请作者喝杯咖啡吧~博客赞助

支付宝扫一扫领取红包,优惠每天领

二维码1

领取红包

二维码2

领红包