圈子CI

CircleCI 是一个基于云的持续集成和持续交付 (CI/CD) 平台。软件开发团队使用 CircleCI 来运行构建作业、自动化测试和编排复杂的工作流程。

要为您的 API 设置 CircleCI 集成，您需要在 CircleCI 中创建 API 令牌并在 Postman 中配置您的 API。设置集成后，您可以在 Postman 中查看构建状态或启动新构建。

创建 CircleCI API 令牌

  1. 登录CircleCI并导航到User Settings > Personal API Tokens。
  2. 选择创建新令牌。
  3. 输入Token Name并选择Add API Token。
  4. 选择复制以复制新令牌。（您可能希望将令牌保存在安全的地方。）

配置 CircleCI 集成

  1. 通过选择左侧边栏中的API，然后选择 API 和版本来打开您的 API 。每个 API 版本只能链接到一个 CI 项目。

  2. 选择测试选项卡。

  3. 在Connect to CI/CD Builds下，选择CircleCI。

    CI 集成

  4. 对于API Key，输入您的 CircleCI 令牌。

  5. 输入昵称以帮助您稍后识别集成。

  6. 选择用于您的 API的CI 项目。

  7. 选择连接。

    添加 API 密钥

为 CircleCI 配置 Newman

在 Newman 和 Postman API 的帮助下，您可以运行在 Postman 中创建的 API 测试作为 CI 管道的一部分。首先在 Postman 中生成 Newman 配置代码。然后将配置代码添加到CircleCI：

  1. 在 CircleCI 中打开您的项目，选择一个分支，然后选择Edit Config。
  2. 粘贴您从 Postman 复制的 Newman 配置：
    • $POSTMAN_API_KEY用有效的Postman API Key替换 的两个实例。
    • 确保将newman-collection-run作业添加到新的或现有的工作流程中。
  3. 选择保存并运行以使用新配置运行管道。
  4. 要在 Postman 中查看测试结果，请打开您的 API 并选择测试选项卡。

示例 CircleCI config.yml

version: 2.1

orbs:
  newman: postman/newman@0.0.2

jobs:
  newman-collection-run:
    executor: newman/postman-newman-docker
    steps:
      - checkout

      - newman/newman-run:
        collection: https://api.getpostman.com/collections/789883-28b680e3-eb56-4135-8f4c-de01a6e494e9?apikey=$POSTMAN_API_KEY
        environment: https://api.getpostman.com/environments/5d1b4d44-ac1e-4eb6-9062-b28cd96333a4?apikey=$POSTMAN_API_KEY

workflows:
  example-workflow:
    jobs:
      - newman-collection-run