Postman进阶功能-集合分支管理与编写接口文档

news2024/11/20 13:32:42

        大家好,在接口测试的领域中,我们不断追求更高效、更便捷、更强大的方法与工具。而 Postman 作为一款备受青睐的接口测试工具,其进阶功能更是为我们打开了新的天地。在这其中,集合分支管理与编写接口文档的功能显得尤为重要。

        当面对日益复杂的接口体系和项目需求时,集合分支管理能够让我们有条不紊地组织和分类接口,使得测试工作更加清晰有序。它就像是为我们的接口测试之旅提供了清晰的导航,帮助我们在众多接口中准确找到目标。

        而编写接口文档这一功能,更是意义非凡。它让接口信息不再孤立,而是形成一个有机的整体。无论是团队协作还是项目交接,详细准确的接口文档都是关键的支撑。它确保了知识的传递和延续,避免了因信息缺失而导致的误解和错误。

一、集合的分支管理

        像 Git 一样,在 Postman 中也有源码管理功能,通过创建团队的 workspace,团队成员就可以在这个 workspace 中像 Git 管理源代码一样,去创建分支、合并分支、拉取分支等。接下来,来了解下 Postman 的这几个功能。

  • 创建集合分支(Create a fork)
  • 合并变更(Merge changes)
  • 创建 pull 请求(Create Pull Request)

1、创建集合分支

        分支的创建,需要基于某个集合中的集合分支创建后,如此,相当于这个集合的主分支,团队成员可以基于这个分支拉取一个新的分支开发,最后,将修改后的新的脚本合并到主分支上。

接下来是创建一个分支:

(1)选中一个集合,点击(...)或右键,点击“Create a fork”。
(2)在弹出的对话框中输入 Fork Label,选择团队的 workspace,点击“Fork collection”。
(3)进入到对应的 workspace,就会查看到对应的 Collection,这里的每个集合,其后都有一个 fork 标志。

2、合并变更

        当在集合中加了新的功能后,就需要把这些变更提交到主分支上,提交成功后,团队成员也就能看到最新的修改数据了。具体操作如下:

(1)点击 Collection 右侧的(...),点击 Merge Changes。
(2)在弹出的页面中,点击右上角的 Merge all changes。注意,此时如果 Merge,Postman 则会提示已经有最新更新了,会提示你去 Pull Changes,这时,你可以先拉取最新的变更,然后再点击 Merge all changes。
(3)在弹出的新对话框中,默认选择 Merge changes,点击 Merge。

3、创建 Pull 请求

当团队提交了最新修改后,就可以通过 Create Pull Request 拉取最新的修改数据。

具体步骤如下:

(1)点击 Collection 右侧的(...),点击 Create pull Request。

(2)在弹出的页面中,输入 title 和描述,点击 Create pull Request。

(3)查看 Postman 请求,最新的更新就会拉取到本地的分支集合中。

 

        在使用的过程中,Postman 中的 Create a fork、Create pull request、Merge change 特别像Git 中的 create branch、pull、push。

二、编写接口文档

        在进行接口测试之时,常常会遭遇所填写的请求数据不清晰这类问题,而这时首先会想到的便是接口文档。然而,在许多情况下,开发人员所撰写的文档并不够完善,其更新也并不够及时,甚至就算更新了,大家也需要跳出工具去寻找对应的接口文档,这给用户带来的体验相当不好。所以,当下出现的一些工具,既能够支持接口调试,同时也支持文档查看,无需在工具与文档之间反复来回地切换。Postman 也同样如此,在 Postman 当中,同样是支持编写接口文档的,并且它的文档功能还极为强大。

1、生成文档

生成文档有两种方式,直接打开链接和新建 API 文档。

第一种:直接打开链接非常简单,首先,选择一个集合,然后,点击右三角 -> 点击 View in web。

第二种,操作步骤如下:

(1)点击左上角的 New,选择 API Documentation 。
(2)弹出的第一个 Tab 页面,有两个选项,新建一个集合/从已有集合选择。这里,根据自己的实际需求来选择即可。
(3)进入到第二个 Tab 页面,输入对集合的一些基本描述,比如基本介绍、认证方式、错误码等。
(4)进入到第三个 Tab 页面,这时会弹出一个链接,直接点击链接,就会进入到接口文档页面。如下图所示:

        以上两种方式,都可以进入文档链接,主要区别在于第二种可以加入一些整体性的说明,如系统概况、认证方式、错误码等。另外,文档是以 Web 形式展现,所以相关查阅者只要知道这个链接,就都可以通过浏览器进行访问。

2、编写文档

        编写文档同样有两种方式,分别是在本地编辑和打开链接在浏览器中进行编辑。无论哪种编辑方式,保存成功后都会自动同步。

本地编辑步骤:

(1)点击集合的右三角,会自动弹出 RUN 的窗口。
(2)选择一个请求点击后,会出现两个链接按钮,分别是 Add a description 和 Open in builder。
(3)点击 Add a description,填写接口描述即可。

在线编辑步骤:

(1)点击集合的右三角,会自动弹出 RUN 的窗口。
(2)点击 View in web,会在浏览器中自动打开该集合的 Web 链接地址。
(3)选择其中请求,点击 Add a description。 

        以上两种方式都可以给接口添加文档描述,且都支持 markdown 语法,编写好的信息也能及时的在文档中所看到,如下图所示是给某个接口添加的文档信息。

点击 Open in builder 这个链接按钮,也能直接打开对应的请求。

以下是以 Web 方式打开的在线文档,在线文档还有个比较实用的功能,就是为每个请求自动生成不同语言的代码,如果你刚好对如何用代码实现不太清楚,可以直接从这里拷贝。

本文来自互联网用户投稿,该文观点仅代表作者本人,不代表本站立场。本站仅提供信息存储空间服务,不拥有所有权,不承担相关法律责任。如若转载,请注明出处:http://www.coloradmin.cn/o/1683026.html

如若内容造成侵权/违法违规/事实不符,请联系多彩编程网进行投诉反馈,一经查实,立即删除!

相关文章

向上调整建堆与向下调整建堆的时间复杂度 AND TopK问题

目录 前言建堆的时间复杂度TOPK问题总结 前言 本篇旨在介绍使用向上调整建堆与向下调整建堆的时间复杂度. 以及topk问题 博客主页: 酷酷学!!! 感谢关注~ 建堆的时间复杂度 堆排序是一种优于冒泡排序的算法, 那么在进行堆排序之前, 我们需要先创建堆, 为什么说堆排序的是优于…

网络模型-VLAN聚合

VLAN聚合 VLAN聚合(VLAN Aggregation,也称SuperVLAN)指在一个物理网络内,用多个VLAN(称为Sub-VLAN)隔离广播域并将这些Sub-VLAN聚合成一个逻辑的VLAN(称为SuperVLAN),这些Sub-VLAN使用同一个IP子网和缺省网关,,进而达到节约IP地址…

leetcode_2024年5月19日10:51:26

238.除自身以外各元素的乘积 给你一个整数数组nums,返回数组answer,其中answer[i]等于nums中除nums[i]之外其余各元素的乘积。 题目数据保证数组nums之中任意元素的全部前缀元素和后缀的乘积都在32位整数范围内。 请不要使用除法,且在o&am…

Go 切片常用操作与使用技巧

1.什么是切片 在 Go 语言中的切片(slice)是一种灵活的动态数组,它可以自动扩展和收缩,是 Go 语言中非常重要的数据结构之一。切片是基于数组实现的,它的底层是数组,可以理解为对底层数组的抽象。它会生成一…

智能车竞赛指南:从零到一,驶向自动驾驶的未来

智能车竞赛指南:从零到一,驶向自动驾驶的未来 一、智能车竞赛概览1.1 竞赛介绍1.2 竞赛分类 二、智能车开发技术基础2.1 硬件平台2.2 软件开发 三、实战案例:循线小车开发3.1 系统架构3.2 代码示例 四、技术项目:基于ROS的视觉导航…

一款功能强大的安卓虚拟机应用——VMOS Pro使用分享

前段时间我刚刚分享一个WeChat平板模块能够允许用户自由修改系统设置,让你的Android备用手机焕发新生,实现手机PAD化,实现两台设备同时登录微信号。今天我分享的这个相比WeChat更为简单,因为它可以通过虚拟机的方式进行多种androi…

【Numpy】深入解析numpy.diag()函数

numpy.diag():深入探索NumPy库中的对角矩阵操作 🌈 欢迎莅临我的个人主页👈这里是我深耕Python编程、机器学习和自然语言处理(NLP)领域,并乐于分享知识与经验的小天地!🎇 &#x1f3…

MGRE实验——路由配置

对134环回 ping一下发现都可以通 配置3,4同3 再注册 然后内网要互通,起rip 宣告1的左边和右边 对3 对4 当3,4之间要互通时,首先在1上 关闭之后,3就能学到4上的用户网段,4也能学到3 局域网要访问广域网一定…

Web 3D 框架简介

前言 3D游戏引擎的历史可以追溯到20世纪80年代末和90年代初。当时,计算机技术迅速发展,人们开始对图形和游戏感兴趣。以下是3D游戏引擎的历史故事: 早期引擎的诞生(1980-1990年代) 在这个时期,一些早期的3D游戏引擎开始出现。其中一个著名的例子是id Software开发的Do…

单细胞分析(Signac): PBMC scATAC-seq 聚类

引言 在本教学指南中,我们将探讨由10x Genomics公司提供的人类外周血单核细胞(PBMCs)的单细胞ATAC-seq数据集。 加载包 首先加载 Signac、Seurat 和我们将用于分析人类数据的其他一些包。 if (!requireNamespace("EnsDb.Hsapiens.v75&qu…

Dijkstra算法在《庆余年》中的应用:范闲的皇宫之旅

❤️❤️❤️ 欢迎来到我的博客。希望您能在这里找到既有价值又有趣的内容,和我一起探索、学习和成长。欢迎评论区畅所欲言、享受知识的乐趣! 推荐:数据分析螺丝钉的首页 格物致知 终身学习 期待您的关注 导航: LeetCode解锁100…

英语学习笔记24——Give me/us/him/her/them some ...

Give me/us/him/her/them some … 给我/我们/他/她/他们一些…… 词汇 Vocabulary desk n. 课桌(有书桌堂),写字台 复数:desks 搭配:desk mate 同桌    构成:desk mate 桌子上的伙伴 同桌    cl…

FBB-Frontiers in Bioengineering and Biotechnology

文章目录 一、期刊简介二、征稿信息三、期刊表现四、投稿须知五、投稿咨询 一、期刊简介 Frontiers in Bioengineering and Biotechnology是专注生物工程和生物技术领域的开放获取期刊。 研究范围涵盖生物材料、生物力学、生物工艺工程、生物安全和生物安保,生物传…

计算机系统基础 7 分支程序的实现

简单条件转移指令 根据单个标志位的值(CF, SF,OF,PF,ZF)来确定是否转移, 如果条件成立,则(EIP) 位移量 ➡ EIP,否则什么也不做。 注意&#xff0…

【Andoird开发】android获取蓝牙权限,搜索蓝牙设备MAC

<!-- Android 12以下才需要定位权限&#xff0c; Android 9以下官方建议申请ACCESS_COARSE_LOCATION --><uses-permission android:name"android.permission.ACCESS_COARSE_LOCATION" /><uses-permission android:name"android.permission.ACCES…

参考文献交叉引用两个文献,逗号隔开

1.引用两个参考文献&#xff0c;定位到word正文中需要引用的位置&#xff0c;然后插入-交叉引用&#xff0c;引好文献 2.选中两个参考文献&#xff0c;切换域代码&#xff0c;然后进行修改&#xff1a; 改为 上面的两张图片中的点是空格的含义&#xff0c;word中按ctrlshift8就…

【计算机网络实验】TCP协议的抓包分析:三次握手四次挥手UDP和TCP的区别(超详细教程)

计算机网络实验——TCP协议抓包分析 文章目录 计算机网络实验——TCP协议抓包分析一、基础知识点1、运输层两个重要协议的特点对比&#xff08;TCP和UDP&#xff09;2、TCP报文的格式3、常见的TCP报文标识字段&#xff08;FLAG字段&#xff09;4、TCP连接的建立过程及理解——三…

CTFshow之文件上传web入门151关-161关解密。包教包会!!!!

这段时间一直在搞文件上传相关的知识&#xff0c;正好把ctf的题目做做写写给自字做个总结&#xff01; 不过有一个确定就是所有的测试全部是黑盒测试&#xff0c;无法从代码层面和大家解释&#xff0c;我找个时间把upload-labs靶场做一做给大家讲讲白盒的代码审计 一、实验准…

多台Centos快速区分,让Centos开机自动显示它的IP地址!

背景说明&#xff1a;当公司拥有多台Centos服务器&#xff0c;管理员很容易弄混淆导致不好区分&#xff0c;在这样的情况下我们可以写个简单脚本来实现开机自动显示它的IP地址&#xff0c;从而达到区分开来的结果&#xff01; 首先我们来开下效果&#xff0c;登录之前的 下面是…

调试时JSON库一直提示 PDB找不到 使用需要对象文件来进行调试的 /DEBUG:Fastlink生成的

最近调试时一直提示上面的提示框&#xff0c;很是烦躁。 为什么会出现这个错误呢&#xff0c;我一直使用的是/DEBUG。出现原因没有找出来&#xff0c;理论上市使用了/DEBUG:Fastlink这个模式才会出&#xff0c;但是就是一直在报这个错误。 /DEBUG&#xff08;生成调试信息&am…