跳到主要内容

CI 和 Postman API

持续集成 (CI) 是一种开发实践,需要开发人员定期将代码更新合并到共享存储库中。它涉及每次开发人员提交代码更新时自动构建和测试代码的过程。

你可以使用 Postman API 访问集合以在持续集成和持续部署 (CI/CD) 环境中运行。

开始之前:

  • 确保你有一个可以运行 shell 命令的 CI 系统设置,并且你有权修改它。
  • 获取 Postman API 密钥 。如果你没有,可以 生成一个 API 密钥
  • 确保你有一个 Postman 集合来测试你的本地主机服务器,并记下该集合的 UID。

开发 API?Postman 提供内置工具,可将你的 API 与一些最广泛使用的持续集成 (CI) 工具集成。为 API 设置 CI 后,你可以在 Postman 中查看构建状态或启动新构建。你还可以使用 Newman 将 API 测试作为 CI 管道的一部分运行。要了解更多信息,请参阅 CI 集成

第 1 步:安装节点

如果你的 CI 已经安装了 Node,你可以跳过这一步。

按照 步骤下载 特定于你的 CI 平台的 Node。否则,某些 CI 具有预安装 Node.js 的配置。确保你使用的是 Node.js v4 或更高版本。

第二步:安装 Newman

Newman 是一个命令行工具,允许你在本地开发环境或你自己的服务器上运行集合。以下命令在你的 CI 中安装 Newman。

第 3 步:运行 Newman

使用适当的参数运行以下 Newman 命令:

newman run https://api.getpostman.com/collections/{{collection_uid}}?apikey={{postman-api-key-here}}

如果需要为集合提供环境,请将--environment带有适当参数的选项添加到 Newman 命令中:

newman run https://api.getpostman.com/collections/{{collection_uid}}?apikey={{postman-api-key-here}}
--environment https://api.getpostman.com/environments/{{environment_uid}}?apikey={{postman-api-key-here}}