ICode9

精准搜索请尝试: 精确搜索
首页 > 其他分享> 文章详细

使用 Postman 实现 API 自动化测试

2022-05-23 05:00:07  阅读:196  来源: 互联网

标签:newman Postman -- html environment json API 自动化 postman


背景介绍

相信大部分开发人员和测试人员对 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:

 

新建请求:

 

测试请求,状态码返回 200:

 

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

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

 

2. 创建 Environment

新建 environment:

 

填写参数信息,这里简单使用 host 作为参数:

 

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

 

3. 导出 CollectionEnvironment

导出 collection 为 collection.json:

 

导出 environment 为 environment.json:

 

 

3. 执行 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 文件

 

执行结果:

 

查看 html 报告:

 

4. 集成 CI 实现 API 自动化测试

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

 

参考总结

以上就是本文希望分享的内容,如果大家有什么问题,欢迎在文章或者公众号 - 跬步之巅留言交流。

标签:newman,Postman,--,html,environment,json,API,自动化,postman
来源: https://www.cnblogs.com/Erik_Xu/p/16299834.html

本站声明: 1. iCode9 技术分享网(下文简称本站)提供的所有内容,仅供技术学习、探讨和分享;
2. 关于本站的所有留言、评论、转载及引用,纯属内容发起人的个人观点,与本站观点和立场无关;
3. 关于本站的所有言论和文字,纯属内容发起人的个人观点,与本站观点和立场无关;
4. 本站文章均是网友提供,不完全保证技术分享内容的完整性、准确性、时效性、风险性和版权归属;如您发现该文章侵犯了您的权益,可联系我们第一时间进行删除;
5. 本站为非盈利性的个人网站,所有内容不会用来进行牟利,也不会利用任何形式的广告来间接获益,纯粹是为了广大技术爱好者提供技术内容和技术思想的分享性交流网站。

专注分享技术,共同学习,共同进步。侵权联系[81616952@qq.com]

Copyright (C)ICode9.com, All Rights Reserved.

ICode9版权所有