CI 集成

持续集成和持续交付 (CI/CD) 是API 开发工作流的核心组件。Postman 与流行的 CI 工具集成,因此您可以在定义和测试 API 的同一位置查看有关 API 构建的详细信息。

设置 CI 集成后,您可以在 Postman 中查看构建状态或启动新构建。此外,在Newman和 Postman API 的帮助下,您可以运行在 Postman 中创建的 API 测试作为 CI 管道的一部分。

配置 CI 集成

要为您的 API 设置 CI 集成,您需要在 CI 工具中创建 API 令牌并在 Postman 中配置您的 API。请参阅 CI 工具的说明:

查看构建状态

设置 CI 集成后,可以在 Postman 中使用 CI 构建作业的状态信息。对于每个构建,您可以查看提交消息、构建运行所在的分支、构建状态(成功或失败)以及构建运行的时间。

要查看构建作业,请打开您的 API 并选择测试选项卡。最近的作业列在最近的运行下。

  • 要在 CI 工具中查看构建,请将光标悬停在构建上并选择View build details
  • 要启动新构建,请选择Run Build。选择或键入分支名称,然后选择Run Build
  • 要编辑或删除积分,请选择三个点三个点图标
查看 CI 最近运行

要查看构建作业的完整列表,请选择查看所有构建。使用下拉列表按分支过滤构建列表或查看所有分支的构建。要获取最新的构建状态信息,请选择Refresh

查看所有 CI 构建

为 CI 配置 Newman

作为 CI 管道的一部分运行 API 测试有助于确保 API 生产者和消费者之间的期望保持同步。

要在每次构建时运行 API 测试,首先在 Postman 中生成所需的 Newman 配置代码。然后将配置代码添加到您的 CI 工具中。配置后,每次 CI 构建运行时,Newman 都会使用 Postman API 运行包含您的测试的集合。您可以在 Postman 中查看测试结果。

在开始之前,请确保您已经设置了API 和 CI 工具之间的集成。

为 Newman 生成配置代码:

  1. 打开您的 API 并选择测试选项卡。
  2. 最近的运行下,选择查看所有构建
  3. 选择配置纽曼
  4. 选择要在 CI 构建期间运行的集合环境。
  5. (可选)选择+ 添加更多以选择要运行的其他集合。
  6. 选择Copy以复制 Newman 配置,然后选择Finish
  7. 将您复制的 Newman 配置添加到 API 存储库中的构建配置文件中。请参阅 CI 工具的说明:
为 CI 生成 Newman 配置