怎么把接口测试塞进 CI CD 流水线？用 Apifox CLI 自动跑测试

在敏捷开发与持续集成 (CI/CD) 体系中，许多团队虽然写好了接口自动化测试用例，却依然处于“人工手动跑测试”的半自动化状态：

开发者提交了 Merge Request，需要提醒测试人员去点一下运行；
部署到测试环境后，没人知道现有的接口有没有被新代码改坏；
往往直到带病上线、线上报错了，才发现是因为某个断言未通过。

真正的自动化测试，必须“无缝塞进 CI/CD 流水线中”——让代码在提交或部署时自动触发测试，只有测试 100% 通过才允许合并和发布。

Apifox 提供了轻量级的命令行工具 Apifox CLI，支持在企业内网环境下无缝嵌入 Jenkins、GitLab CI、GitHub Actions 等流水线，实现“提码即跑、坏码阻断”。

一、 Apifox CLI 的内网工作原理

Apifox CLI 是 Apifox 官方专为 CI/CD 流水线研发的命令行执行器：

┌────────────────────────────────────────────────────────────────────────┐
│                    Apifox CLI 内网 CI/CD 流水线架构                     │
│                                                                        │
│   ┌──────────────┐      ┌─────────────────────────┐      ┌───────────┐ │
│   │ 开发者提交   │ ──►  │ Jenkins / GitLab CI     │ ──►  │ 部署至测试 │ │
│   │ 代码 (Git)   │      │ 触发流水线 Pipeline      │      │ 内网环境  │ │
│   └──────────────┘      └────────────┬────────────┘      └───────────┘ │
│                                      │                                 │
│                                      ▼ 命令行运行                       │
│                         ┌─────────────────────────┐                    │
│                         │ Apifox CLI 自动化测试   │                    │
│                         │ npx apifox-cli run ...  │                    │
│                         └────────────┬────────────┘                    │
│                                      │                                 │
│                    ┌─────────────────┴─────────────────┐               │
│                    ▼                                   ▼               │
│         [测试通过 Exit Code 0]               [测试失败 Exit Code 1]    │
│         允许合并入主分支 / 发布              阻断流水线 + 推送飞书告警 │
│                                                                        │
└────────────────────────────────────────────────────────────────────────┘

纯内网安全运行：Apifox CLI 可以在内网 Jenkins 节点或 K8s CI Runner 容器中直接安装运行，测试数据与请求纯在企业内网流转；
退出码 (Exit Code) 机制：测试全部通过返回 Exit Code 0，任何一个步骤断言失败返回 Exit Code 1，天然契合 Jenkins / GitLab CI 的失败阻断逻辑；
输出多样化报告：支持在命令行输出漂亮的彩色控制台日志，或导出 HTML / JUnit XML 格式报告供 CI 页面展示。

二、接入 Jenkins 与 GitLab CI 实战代码

在流水线 Pipeline 脚本中嵌入 Apifox CLI 极其简单：

1. Jenkins Pipeline (`Jenkinsfile`) 完整实战代码

pipeline {
    agent any
    environment {
        APIFOX_TOKEN = credentials('apifox-ci-token') // 从 Jenkins 凭证库安全获取 Token
        APIFOX_SERVER = 'http://apifox.internal-domain.com'
    }
    stages {
        stage('Deploy to Staging') {
            steps {
                echo '部署最新代码至内网 Staging 测试环境...'
                sh './deploy-staging.sh'
            }
        }
        stage('Run Apifox API Automation Tests') {
            steps {
                echo '触发 Apifox 自动化测试套件...'
                sh '''
                npx apifox-cli run --api-scene=987654 \
                    --environment=staging \
                    --apifox-api-base-url=${APIFOX_SERVER} \
                    --access-token=${APIFOX_TOKEN} \
                    -r html,cli,junit \
                    --out-file=apifox-report.html
                '''
            }
            post {
                always {
                    junit 'apifox-report.xml' // 归档 JUnit 报告
                    archiveArtifacts artifacts: 'apifox-report.html'
                }
            }
        }
    }
}

2. GitLab CI (`.gitlab-ci.yml`) 代码示例

stages:
  - test

api_automation_test:
  stage: test
  image: node:18-alpine
  script:
    - npx apifox-cli run --api-scene=$SCENE_ID --environment=test --apifox-api-base-url=$INTERNAL_APIFOX_URL --access-token=$APIFOX_TOKEN -r junit --out-file=junit.xml
  artifacts:
    when: always
    reports:
      junit: junit.xml

三、阻断上线与即时通告闭环

结合流水线的条件分支，建立起全自动质量防护网：

测试通过：Jenkins 继续执行 Docker 镜像打包与 Kubernetes 生产发布；
测试失败：Jenkins 立刻终止 Pipeline 构建，自动抓取 Apifox CLI 的错误输出，通过 Webhook 向研发钉钉/飞书群发送“编译合并被自动拦截”警告，附带具体的失败接口与堆栈。