通用 Runner
自动化测试定时任务、定时导入接口文档、返回 Mock 响应结果等工作。准备工作
快速上手
1. 部署通用 Runner
2. 获取部署 Runner 命令
1.
2.
3.
-p 参数，你可以将容器内部的端口映射到宿主机的端口上，使得外部可以访问容器提供的服务。例如，-p 80:4524表示将容器内部的 4524 端口映射到宿主机的 80 端口。4.
-v参数可以将宿主机的目录挂载到容器内部，这样容器就可以访问和操作宿主机上的文件（数据库配置、外部程序等）。例如，-v "/opt/runner":/opt/runner表示将宿主机的/opt/runner目录挂载到容器的/opt/runner目录。3. 在服务器上部署 Runner
4. 在服务器上查看 Runner 状态
docker ps 命令，查看容器的运行情况。5. 在 Apifox 中查看已部署的通用 Runner
如果已在服务器上成功部署通用 Runner，但是在 Apifox 客户端中并没有显示，请点击“通用 Runner”右侧的刷新按钮刷新页面后再次查看。
| 状态 | 说明 |
|---|---|
| 已启动 / Started | Runner 在服务器的容器中正常启用并与 Apifox 保持通信中，可以处理 Apifox 下发的相关任务。 |
| 已停用 / Stopped | Runner 在 Apifox 中手动停用，但是在服务器的容器中正常运行并保持通信。此时不会处理 Apifox 下发的各类任务，新的任务也不可指定停用的 Runner 执行。可以在 Apifox 中手动启用来让此 Runner 重新恢复已启动状态。 |
| 已离线 / Offline | Runner 与 Apifox 通信中断，无法处理 Apifox 下发的任务。可能原因为 Runner 容器已在服务器中停止运行，服务器与 Apifox 服务端通信异常等。此时可以通过恢复 Runner 容器运行并确保与 Apifox 通信没有问题，来让此 Runner 重新恢复已启动状态。 |
服务器 Host 配置
在 Runner 中保存文件
| 使用内容 | 示例目录路径或文件名 |
|---|---|
| 其它编程语言 | /opt/apifox/runner/external-programs/ |
| 数据库连接配置文件 | /opt/apifox/runner/database/database-connections.json |
| SSL 证书列表文件 | /opt/apifox/runner/ssl/ssl-client-cert-list.json |
/opt/apifox/runner 为默认挂载目录，可在部署界面或容器内使用 -v 命令更改。{
"19731": {
"configs": {
"default": {
"username": "accountname",
"password": "123456",
"host": "192.168.0.0"
}
},
"id": 19731,
"name": "Database Name",
"type": "mysql",
"projectId": 1320441,
"description": "Dummy data.",
"createdAt": "2022-09-27T07:51:09.000Z",
"updatedAt": "2024-05-09T11:38:07.000Z",
"deletedAt": null
}
}你可以参考CLI 命令选项查看从 Apifox 客户端中导出配置文件的方法。
[
{
"name": "domain1",
"matches": ["https://test.domain1.com/*", "https://www.domain1/*"],
"key": {"src": "./client.domain1.key"},
"cert": {"src": "./client.domain1.crt"},
"passphrase": "changeme"
},
{
"name": "domain2",
"matches": ["https://domain2.com/*"],
"key": {"src": "./client.domain2.key"},
"cert": {"src": "./client.domain2.crt"},
"passphrase": "changeme"
}
]升级&重新部署 Runner
常见问题
修改于 2025-02-06 08:03:03