使用postman+newman生成HTML/HTMLeXtra API测试报告

老板娘来碗三鲜粉 / 2023-06-06 / 原文

引言

在现代软件开发中，API（应用程序接口）起着至关重要的作用。为了确保API的功能正常并符合预期，测试是不可或缺的一环。本文将介绍如何结合Postman、Newman和HTML/HTMLeXtra来创建强大的API测试报告，以提升测试效率和可视化展示。

1、安装和配置postman：

首先，确保你已经安装了Postman。打开Postman并创建一个新的集合（Collection）来组织你的API测试请求。在集合中，添加多个请求，并为每个请求定义URL、请求方法、请求头、请求体等。你还可以为每个请求添加预期结果和断言来验证API的响应是否符合预期

2、使用postman运行和调试请求：

在集合中添加完测试请求后，你可以使用Postman手动运行和调试这些请求。通过发送请求并查看响应，你可以验证API的行为是否正确，并进行必要的调试和修改

3、导出postman集合为JSON文件：

完成测试请求的创建和调试后，将Postman集合导出为JSON文件，以便在命令行中使用Newman执行这些测试请求。在Postman中，选择你的集合，点击右上角的三个点图标，然后选择"Export"->"Collection"，将集合导出为JSON文件。

4、安装和配置Newman：

安装 Node.js：Newman 是一个 Node.js 包，因此在安装之前需要先安装 Node.js。从 Node.js 官方网站（https://nodejs.org）下载跟你操作系统对应的包，参考博客https://zhuanlan.zhihu.com/p/442215189
安装 npm：npm 是 Node.js 的包管理器，它用于安装和管理 Node.js 包。当你安装 Node.js 时，npm 通常会一同安装。你可以通过在命令行界面中输入 npm -v 来检查是否安装了 npm，并查看其版本号

确保已经安装了Node.js和npm。在命令行中运行以下命令来安装，

npm install -g newman

安装完成后，可以使用以下命令验证Newman是否成功安装：

newman --version

newman快速运行

5、下载HTML插件或者HTMLeXtra插件

npm install -g newman-reporter-html

npm install -g newman-reporter-htmlextra

6、生成测试报告：

使用Newman运行Postman集合并生成测试报告。在命令行中，切换到存储Postman集合的JSON文件的目录，并运行以下命令来生成HTML报告：

newman run [collection.json] --reporters html --reporter-html-export [report.html]

newman run [collection.json] --reporters htmlextra --reporter-htmlextra-export [report.html]

在上述命令中，[collection.json]是你的Postman集合的JSON文件路径，[report.html]是要生成的报告的文件路径。运行命令后，Newman将执行集合中的所有请求，并生成相应的测试报告。