首页
/ Newman Action 使用指南

Newman Action 使用指南

2025-05-28 23:26:40作者:伍霜盼Ellen

1. 项目介绍

Newman Action 是一个GitHub Action,允许用户通过GitHub Action运行Postman的头部收集器(headless collection runner),即 Newman。这个Action旨在简化在持续集成(CI)过程中执行API测试的流程,无需配置Newman库本身。

2. 项目快速启动

在开始之前,请确保您已经有一个GitHub仓库和Postman集合以及环境。

以下是一个基本的GitHub Actions workflow文件的例子,它将使用Newman Action运行您的Postman集合:

name: Newman Run

on:
  pull_request:
    branches:
      - master

jobs:
  newman:
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@master
      - uses: matt-ball/newman-action@master
        with:
          collection: postman_collection.json # 相对于仓库根目录的路径或URL
          environment: postman_environment.json # 相对于仓库根目录的路径或URL

将上述代码保存为 .github/workflows/newman.yml 在您的GitHub仓库中。

确保您的Postman集合和环境文件已经放在指定的路径下,或者替换为您的文件URL。

3. 应用案例和最佳实践

  • 使用本地文件:如果您的集合和环境文件已经保存在GitHub仓库中,可以直接通过相对路径引用。

  • 使用URL:如果您的集合和环境文件可通过URL访问,可以直接将URL传递给Action。

  • 使用Postman API:通过Postman API获取最新版本的集合和环境,并使用您的Postman API密钥进行认证。确保API密钥被添加到GitHub仓库的Secrets中。

  • 自定义设置:除了apiKeycollectionenvironment之外,所有其他Newman设置也被支持。例如,您可以添加延迟请求或自定义环境变量。

4. 典型生态项目

Newman Action 可以与其他GitHub Actions结合使用,例如:

  • 在代码合并到主分支之前,自动运行API测试。
  • 当API变更时,触发集成测试。
  • 作为持续集成(CI)流程的一部分,确保API的质量。

结合使用这些项目可以帮助您的团队确保API的稳定性和可靠性。

登录后查看全文
热门项目推荐