使用 Postman 实现 API 自动化测试-Toy模板网

这篇具有很好参考价值的文章主要介绍了使用 Postman 实现 API 自动化测试。希望对大家有所帮助。如果存在错误或未考虑完全的地方，请大家不吝赐教，您也可以点击"举报违法"按钮提交疑问。

目录：导读

背景介绍

名词解析

使用说明

执行 API 测试

集成 CI 实现 API 自动化测试

写在最后

使用 Postman 实现 API 自动化测试

背景介绍

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

名词解析

1. Collection

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

2. Environment

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

使用说明

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

1. 创建 Collection

新建 collection：

使用 Postman 实现 API 自动化测试

新建请求：

使用 Postman 实现 API 自动化测试

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

使用 Postman 实现 API 自动化测试

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

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

使用 Postman 实现 API 自动化测试

2. 创建 Environment

新建 environment：

使用 Postman 实现 API 自动化测试

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

使用 Postman 实现 API 自动化测试

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

使用 Postman 实现 API 自动化测试

3. 导出 Collection 和 Environment

导出 collection 为 collection.json：

使用 Postman 实现 API 自动化测试

导出 environment 为 environment.json：

使用 Postman 实现 API 自动化测试

执行 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'

指令解析：

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

执行结果：

使用 Postman 实现 API 自动化测试

查看 html 报告：

使用 Postman 实现 API 自动化测试

集成 CI 实现 API 自动化测试

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

写在最后

如果你觉得文章还不错，请大家 点赞、分享、留言 下，因为这将是我持续输出更多优质文章的最强动力！

看到这篇文章的人有觉得我的理解有误的地方，也欢迎评论和探讨～

你也可以加入下方的的群聊去和同行大神交流切磋

文章来源地址https://www.toymoban.com/news/detail-404152.html