跳到主要内容

持续集成功能简介

视频内容

持续集成的主要目标是通过频繁地代码集成和测试代码改动后的运行情况,尽早地发现和解决可能存在的问题。你可以使用 Apifox CLI 与你的持续集成工作流相结合,便捷地执行已在 Apifox 预设的测试场景。


Apifox 中的持续集成自动化测试文件支持以 Apifox CLIPostmanJmeter 格式数据导出。

前置准备

提前在持续集成环境中安装 Apifox CLI


在客户端通过配置生成命令

打开一个测试场景,在上方的 tab 中切换到 CI/CD 页面内(新版 CI/CD 页面),即可看到运行配置及基于上方的运行配置,由系统自动生成的 CLI 命令。

在客户端通过配置生成命令


向命令中添加 Access Token 进行使用

在命令行中运行命令时,需要添加 Access Token 作为参数,以便于 Apifox 识别用户身份。

向命令中添加 Access Token 进行使用

运行持续集成

与 CI/CD 平台相集成

Apifox 支持自动生成 Jenkins、Github Actions 等配置代码,你可以将它粘贴至 CI/CD 平台的配置文件中,与现有的研发工作流相结合。


注意代码里的$APIFOX_ACCESS_TOKEN变量需要替换为你的实际 Access Token,或者在 CI/CD 平台中添加一个键为APIFOX_ACCESS_TOKEN的环境变量,值则设置为你的 Access Token,这样在执行命令时才会读取到你的 Access Token。

与 CI/CD 平台相集成

通过 CLI 实时运行在线数据

持续集成配置保存后将自动在页面中生成一串可运行命令行。

通过 CLI 实时运行在线数据

示例代码如下:

apifox run --access-token APS-If8Mexpxxxxxxxxxxxxxxxxxxx -t 4901173 -e 23605453 -n 1 -r html,cli
提示

若在测试步骤中引用了环境变量,那么导出文件时将直接使用变量中预设的远程值。

导出数据后运行

若希望在本地环境中通过 Apifox CLI 运行此测试场景,那么需要先「导出」当前测试场景下的 Json 文件,然后通过 Apifox CLI 工具运行该文件。

导出数据后运行

将以下命令中的 examples/sample.apifox-cli.json 替换为你的文件保存路径,然后在终端中运行。

apifox run examples/sample.apifox-cli.json -r cli,html
提示

若在测试步骤中引用了环境变量,那么导出文件时将直接使用变量中预设的本地值。