什么是 newman
Newman 是 Postman 团队开发的一款命令行工具,用于运行和测试 Postman Collections。它可以在命令行中使用,也可以通过 Jenkins、Travis CI 等持续集成平台来运行,是 API 自动化测试的重要工具。
为什么需要 newman-reporter-html-enhanced
默认情况下,Newman 的测试结果会以 JSON 或者 HTML 格式输出,其中 JSON 格式只给机器看,而 HTML 格式虽然方便阅读,但是它还是比较基础,不能够满足特定需求。而 newman-reporter-html-enhanced 正是为了解决这个问题而存在的,它可以根据用户的需求生成自定义的 HTML 报告,方便阅读和分析。
安装和使用
安装
npm install -g newman-reporter-html-enhanced
使用
在命令行中使用以下命令即可完成测试并生成报告:
newman run [collection] -r html-enhanced --reporter-html-enhanced-export [output_file].html
其中 collection
表示 Postman Collection 的 JSON 文件路径,output_file
表示 HTML 报告的输出路径。
此外,newman-reporter-html-enhanced 提供了很多定制化选项,能让你生成适合自己团队的报告。
以下是一些常用选项:
-R <library>
: 使用不同的渲染库,支持bootstrap3
、html2canvas
和screenshot-stream
。默认情况下为bootstrap3
,即使用 Bootstrap 3 来渲染 HTML。--reporter-html-enhanced-title "<title>"
: 设置 HTML 页面的标题,适用于自定义报告或将其添加到现有网站的页面中。--reporter-html-enhanced-inject-style "<style>"
: 插入自定义 CSS 样式,与 HTML 样式标签中的样式类似。--reporter-html-enhanced-inject-script "<script>"
: 插入自定义脚本,与 HTML script 标签中的脚本类似。--reporter-html-enhanced-title-as-folders
: 使用 Collection 与 Folder 的名称作为每个测试的标题。
示例代码
以下是使用 newman-reporter-html-enhanced 生成报告的示例代码:
newman run mycollection.json -r html-enhanced \ --reporter-html-enhanced-export report.html \ --reporter-html-enhanced-template example/template.hbs \ --reporter-html-enhanced-title "My Custom Title" \ --reporter-html-enhanced-inject-style "example/style.css"
此命令将运行名为 mycollection.json
的 Collection 并生成一个名为 report.html
的 HTML 报告。此外,还可以指定模板、自定义标题和样式。
来源:JavaScript中文网 ,转载请注明来源 https://www.javascriptcn.com/post/6005678581e8991b448e3e7b