Newman 开源项目使用教程

Newman 开源项目使用教程

newmanpostmanlabs/newman: 是一个用于 API 测试的工具，支持多种请求方式和测试场景，可以将 API 测试自动化并生成测试报告，适合用于 API 测试和质量保证。项目地址:https://gitcode.com/gh_mirrors/ne/newman

1. 项目的目录结构及介绍

Newman 是一个用于 Postman 集合的命令行运行工具。以下是 Newman 项目的主要目录结构及其介绍：

newman/
├── bin/
│   └── newman.js
├── lib/
│   ├── cli/
│   ├── reporters/
│   ├── run/
│   └── utils/
├── test/
│   ├── fixtures/
│   ├── integration/
│   └── unit/
├── package.json
├── README.md
└── LICENSE

• bin/：包含 Newman 的可执行文件 newman.js。
• lib/：包含 Newman 的核心逻辑代码，包括命令行接口、报告生成、运行逻辑和工具函数。
• test/：包含 Newman 的测试代码，分为单元测试、集成测试和测试用例。
• package.json：项目的依赖和脚本配置文件。
• README.md：项目的介绍和使用说明。
• LICENSE：项目的开源许可证。

2. 项目的启动文件介绍

Newman 的启动文件是 bin/newman.js。这个文件是 Newman 的入口点，负责解析命令行参数并调用相应的功能模块。

#!/usr/bin/env node

const cli = require('../lib/cli');
const newman = require('../lib/newman');

cli.parse(process.argv, (err, argv, output) => {
    if (err) {
        console.error(output);
        process.exit(1);
    } else {
        newman.run(argv, (err, summary) => {
            if (err) {
                console.error(err);
                process.exit(1);
            }
            console.log(summary.report);
        });
    }
});

• #!/usr/bin/env node：指定使用 Node.js 运行该脚本。
• cli.parse：解析命令行参数。
• newman.run：运行 Newman 集合。

3. 项目的配置文件介绍

Newman 的配置主要通过命令行参数进行。以下是一些常用的配置选项：

• -c, --collection：指定要运行的 Postman 集合文件。
• -e, --environment：指定要使用的环境文件。
• -r, --reporters：指定要使用的报告器。
• -n, --iteration-count：指定迭代次数。
• -d, --iteration-data：指定迭代数据文件。

例如：

newman run -c collection.json -e environment.json -r cli,html

• -c collection.json：指定集合文件。
• -e environment.json：指定环境文件。
• -r cli,html：指定使用命令行和 HTML 报告器。

通过这些配置选项，用户可以灵活地运行和测试 Postman 集合。

newmanpostmanlabs/newman: 是一个用于 API 测试的工具，支持多种请求方式和测试场景，可以将 API 测试自动化并生成测试报告，适合用于 API 测试和质量保证。项目地址:https://gitcode.com/gh_mirrors/ne/newman