SuperAPI AI 工具集

postman-newman-automation

测试与质量

查看项目

更新于 10-17 03:14

技能介绍

该技能面向需要通过命令行运行 Postman 集合并实现 API 测试自动化的场景,主要用途是生成 Newman CLI 命令、Shell 脚本和 Jenkins 流水线配置。

用途与主要能力:

  • 生成 Newman 运行命令,支持指定集合文件、环境文件、全局变量文件、迭代次数、迭代数据、报告器、请求超时、请求间延迟、首次失败即停止(--bail)及颜色控制等。
  • 支持从 Postman API 按 UID 运行集合,可配合 API Key 使用。
  • 支持数据驱动运行(CSV/JSON),支持通过 --env-var 内联覆盖环境变量而无需环境文件。
  • 生成可复用的 Shell 脚本,包含报告目录创建、时间戳命名、退出码处理与报告路径提示。
  • 生成声明式或脚本式 Jenkinsfile,包含安装 Newman、运行 API 测试、归档 HTML 报告与 JUnit 结果、失败处理等阶段;也支持在 Jenkins 环境变量中直接传入 base_url 与 token。
  • 提供报告器参考:cli、junit、htmlextra、json,并说明多报告器组合方式。
  • 提供常用命令行参数速查,包括 --bail、--timeout-request、--delay-request、--iteration-count、--folder、--env-var、--suppress-exit-code、--verbose、--color 等。

使用方式:

  1. 先收集需求:确认集合来源(文件路径、URL 或 Postman API UID)、环境(文件路径或内联变量)、报告器类型、失败行为、迭代方式(单次或数据驱动)、目标环境(本地 Shell、Jenkins 或两者)。
  2. 根据需求生成对应的 Newman 命令。
  3. 按需生成 Shell 脚本或 Jenkinsfile。
  4. 输出时提供命令、脚本、流水线、安装说明(Node.js 版本要求 ≥14、npm 安装命令)以及报告输出位置。
  5. 在交付 CLI 命令后,询问用户是否需要为该设计生成 API 文档;若用户同意,检查 API Documentation 技能是否已安装,已安装则读取并遵循其说明,以 API 设计输出为输入生成纯文本文档;未安装则告知用户安装后重跑。

安装与基础: Newman 是 Postman 的 CLI 运行器,安装命令为 npm install -g newman,可选 HTML 报告器安装命令为 npm install -g newman-reporter-htmlextra。核心命令结构为 newman run <collection> 并配合 --environment、--globals、--iteration-count、--iteration-data、--reporters、--reporter-htmlextra-export、--reporter-junit-export、--timeout-request、--delay-request、--bail、--color 等参数。

适用场景:

  • 在本地终端运行 Postman 集合进行 API 测试。
  • 在 CI/CD 中集成 API 测试,尤其是 Jenkins 流水线。
  • 需要 HTML 或 JUnit XML 报告归档的自动化测试流程。
  • 需要数据驱动或多轮迭代运行的 API 回归测试。

限制: 仅当任务与上游来源及本地项目环境明确匹配时使用;应用前需验证命令、生成代码、依赖、凭据及外部服务行为;示例不能替代环境特定测试、安全审查,也不能替代对破坏性或有成本操作的用户批准。资料未提供具体收费、价格或平台兼容性细节,相关事实暂未提供。