使用 Postman 实现 API 自动化测试

今天药忘吃喽~ 2023-10-08 18:37 40阅读 0赞

### **目录：导读** ###

背景介绍

名词解析

使用说明

执行 API 测试

集成 CI 实现 API 自动化测试

写在最后

--------------------

![a50e82c770c40df56d3193462c571e1f.png][]

### 背景介绍 ###

相信大部分开发人员和测试人员对 postman 都十分熟悉，对于开发人员和测试人员而言，使用 postman 来编写和保存测试用例会是一种比较方便和熟悉的方式。但 postman 本身是一个图形化软件，相对较难或较麻烦（如使用 RPA）实现自动化测试。幸运的是，postman 还提供了一个命令行工具 newman，我们可以借助 postman + newman 来实现 API 自动化测试。

### 名词解析 ###

**1. Collection**

Collection 是一组保存的请求，postman 中发送的每个请求都会显示在侧栏的 ”历史记录“ 选项卡下。请求数量比较少的时候，通过历史记录来重用请求会比较方便。随着请求量的增长，在历史记录中查找特定请求可能会非常耗时。此时，你可以将所有请求保存为一个 collection，以便于访问。

**2. E****nvironment**

Environment 是一组可以在 postman 请求中使用的变量。你可以根据不同的环境（如 dev、test、prod 等），把一组相关的变量放到不同的 environment 文件中，来对不同的环境进行 API 自动化测试。

### 使用说明 ###

我们以测试百度的 [https://www.baidu.com/sugrec][https_www.baidu.com_sugrec] 这个 API 作为示例。

**1. 创建 Collection**

新建 collection：

![7b229fa06ef4b9a5bc7b5a1b75fc049c.png][]

新建请求：

![6aff5328bf22b1a65f4023c1feba2713.png][]

测试请求，状态码返回 200：

![800b5bd23c7f9c1d7fe7bfb4c90d48a1.png][]

编写测试断言并验证断言：

pm.test("Return 200", function() {
        pm.response.to.have.status(200)
    })

![835d2dc7de052a08da485df8c2efbffc.png][]

**2. 创建 Environment**

新建 environment：

![ea69c7fa69077253cd10245d6405d298.png][]

填写参数信息，这里简单使用 host 作为参数：

![56276b97e59aa547666f74298e5eb593.png][]

在 collection 的请求中使用 host 参数，并进行测试：

![f2d1374231b55f95c304a391f581105e.png][]

**3. 导出 Collection 和 Environment**

导出 collection 为 collection.json：

![27d5d5aa0598f9c601fadee30220ada9.png][]

![f4d9dfc6d13c59807e20e6829d2f3eb4.png][]

导出 environment 为 environment.json：

![5e0b5b5af4d93e69e897e913f92c8c80.png][]

![2339b974c6e930e0d80d9c9587565055.png][]

### **执行 API 测试** ###

我们只需要基于导出的 collection.json 和 environment.json 执行一条 docker 指令即可完成 API 测试：

docker run --rm -i -v /root/postman:/etc/newman \
        --entrypoint sh postman/newman:alpine -c \
        'npm i -g newman-reporter-html; \
        newman run collection.json \
        --suppress-exit-code 1 \
        --color off \
        --reporters cli,html\
        --reporter-html-export api_report.html \
        --environment=environment.json'

指令解析：

<table> 
 <tbody> 
  <tr> 
   <td style="vertical-align:top;"><strong>项目</strong></td> 
   <td style="vertical-align:top;"><strong>说明</strong></td> 
  </tr> 
  <tr> 
   <td style="vertical-align:top;">docker run</td> 
   <td style="vertical-align:top;">启动 docker 容器</td> 
  </tr> 
  <tr> 
   <td style="vertical-align:top;">--rm&nbsp;</td> 
   <td style="vertical-align:top;">退出容器时销毁容器</td> 
  </tr> 
  <tr> 
   <td colspan="1" style="vertical-align:top;">-i</td> 
   <td colspan="1" style="vertical-align:top;">交互模式</td> 
  </tr> 
  <tr> 
   <td colspan="1" style="vertical-align:top;">-v /root/postman:/etc/newman</td> 
   <td colspan="1" style="vertical-align:top;">目录挂载</td> 
  </tr> 
  <tr> 
   <td colspan="1" style="vertical-align:top;">--entrypoint sh postman/newman:alpine -c</td> 
   <td colspan="1" style="vertical-align:top;">容器执行指令</td> 
  </tr> 
  <tr> 
   <td colspan="1" style="vertical-align:top;">npm i -g newman-reporter-html</td> 
   <td colspan="1" style="vertical-align:top;">安装 html 报告插件</td> 
  </tr> 
  <tr> 
   <td colspan="1" style="vertical-align:top;">newman run collection.json</td> 
   <td colspan="1" style="vertical-align:top;">指定测试 collection.json</td> 
  </tr> 
  <tr> 
   <td colspan="1" style="vertical-align:top;">--suppress-exit-code 1&nbsp;</td> 
   <td colspan="1" style="vertical-align:top;">指定错误状态码为 1</td> 
  </tr> 
  <tr> 
   <td colspan="1" style="vertical-align:top;">--color off&nbsp;</td> 
   <td colspan="1" style="vertical-align:top;">关闭颜色</td> 
  </tr> 
  <tr> 
   <td colspan="1" style="vertical-align:top;">--reporters cli,html</td> 
   <td colspan="1" style="vertical-align:top;">输出命令行和 html 报告</td> 
  </tr> 
  <tr> 
   <td colspan="1" style="vertical-align:top;">--reporter-html-export api_report.html</td> 
   <td colspan="1" style="vertical-align:top;">设置输出 html 文件名</td> 
  </tr> 
  <tr> 
   <td colspan="1" style="vertical-align:top;">--environment=environment.json</td> 
   <td colspan="1" style="vertical-align:top;">指定&nbsp;environment.json 文件</td> 
  </tr> 
 </tbody> 
</table>

执行结果：

![fd688cdae7da0b9075e94484561afce5.png][]

![fde04d6b21cd07f908e87ea11eadddb6.png][]

查看 html 报告：

![bcd2e6d7a82ae260c395d5cf0d23db26.png][]

### **集成 CI 实现 API 自动化测试** ###

你只需要针对你的代码项目准备好 collection.json 和 environment.json，把它们存放到代码中的某个目录，然后在 jenkins 或 gitlab-ci 中添加执行上面介绍的 docker 指令即可。

### **写在最后** ###

> 如果你觉得文章还不错，请大家 **点赞、分享、留言** 下，因为这将是我持续输出更多优质文章的最强动力！
> 
> 看到这篇文章的人有觉得我的理解有误的地方，也欢迎评论和探讨～
> 
> 你也可以加入下方的的群聊去和同行大神交流切磋
> 
> ![d09e7ef7680f4bd8a19d93c5446ed267.png][]![d09e7ef7680f4bd8a19d93c5446ed267.png][]![d09e7ef7680f4bd8a19d93c5446ed267.png][]![d09e7ef7680f4bd8a19d93c5446ed267.png][]![d09e7ef7680f4bd8a19d93c5446ed267.png][]![d09e7ef7680f4bd8a19d93c5446ed267.png][]![d09e7ef7680f4bd8a19d93c5446ed267.png][]![d09e7ef7680f4bd8a19d93c5446ed267.png][]![d09e7ef7680f4bd8a19d93c5446ed267.png][]

[a50e82c770c40df56d3193462c571e1f.png]: https://img-blog.csdnimg.cn/img_convert/a50e82c770c40df56d3193462c571e1f.png
[https_www.baidu.com_sugrec]: https://www.baidu.com/sugrec
[7b229fa06ef4b9a5bc7b5a1b75fc049c.png]: https://img-blog.csdnimg.cn/img_convert/7b229fa06ef4b9a5bc7b5a1b75fc049c.png
[6aff5328bf22b1a65f4023c1feba2713.png]: https://img-blog.csdnimg.cn/img_convert/6aff5328bf22b1a65f4023c1feba2713.png
[800b5bd23c7f9c1d7fe7bfb4c90d48a1.png]: https://img-blog.csdnimg.cn/img_convert/800b5bd23c7f9c1d7fe7bfb4c90d48a1.png
[835d2dc7de052a08da485df8c2efbffc.png]: https://img-blog.csdnimg.cn/img_convert/835d2dc7de052a08da485df8c2efbffc.png
[ea69c7fa69077253cd10245d6405d298.png]: https://img-blog.csdnimg.cn/img_convert/ea69c7fa69077253cd10245d6405d298.png
[56276b97e59aa547666f74298e5eb593.png]: https://img-blog.csdnimg.cn/img_convert/56276b97e59aa547666f74298e5eb593.png
[f2d1374231b55f95c304a391f581105e.png]: https://img-blog.csdnimg.cn/img_convert/f2d1374231b55f95c304a391f581105e.png
[27d5d5aa0598f9c601fadee30220ada9.png]: https://img-blog.csdnimg.cn/img_convert/27d5d5aa0598f9c601fadee30220ada9.png
[f4d9dfc6d13c59807e20e6829d2f3eb4.png]: https://img-blog.csdnimg.cn/img_convert/f4d9dfc6d13c59807e20e6829d2f3eb4.png
[5e0b5b5af4d93e69e897e913f92c8c80.png]: https://img-blog.csdnimg.cn/img_convert/5e0b5b5af4d93e69e897e913f92c8c80.png
[2339b974c6e930e0d80d9c9587565055.png]: https://img-blog.csdnimg.cn/img_convert/2339b974c6e930e0d80d9c9587565055.png
[fd688cdae7da0b9075e94484561afce5.png]: https://img-blog.csdnimg.cn/img_convert/fd688cdae7da0b9075e94484561afce5.png
[fde04d6b21cd07f908e87ea11eadddb6.png]: https://img-blog.csdnimg.cn/img_convert/fde04d6b21cd07f908e87ea11eadddb6.png
[bcd2e6d7a82ae260c395d5cf0d23db26.png]: https://img-blog.csdnimg.cn/img_convert/bcd2e6d7a82ae260c395d5cf0d23db26.png
[d09e7ef7680f4bd8a19d93c5446ed267.png]: https://img-blog.csdnimg.cn/d09e7ef7680f4bd8a19d93c5446ed267.png