1
0
Fork 0

feat(apifox-runner): update to version 1.9.0 with enhanced documentation and support features

- Update version from 1.8.1 to 1.9.0 with new Docker image tag and latest version auto-update support
- Standardize parameter labels to "Parameter {ENV_KEY}" format with consistent description rules
- Update application description to focus on self-hosted universal runner and change category to tool
- Add multi-architecture support for amd64 and arm64 platforms
- Simplify README documentation by removing redundant content, focusing on installation steps, and emphasizing latest version recommendations
This commit is contained in:
pooneyy 2025-11-15 21:27:26 +08:00
parent 2be04d748d
commit 597d31a240
No known key found for this signature in database
6 changed files with 123 additions and 72 deletions

View File

@ -24,40 +24,43 @@ additionalProperties:
- default: "https://api.apifox.cn"
edit: true
envKey: SERVER_APP_BASE_URL
labelZh: 应用服务地址
labelEn: App Server address
labelZh: 参数 SERVER_APP_BASE_URL
labelEn: Parameter SERVER_APP_BASE_URL
label:
en: App Server address
zh: 应用服务地址
en: Parameter SERVER_APP_BASE_URL
zh: 参数 SERVER_APP_BASE_URL
description:
en: Fill in the parameters provided by the website; all remaining parameters follow the same rule.
zh: 填入网站给出的参数,余下参数皆如此
required: true
type: text
- default: ""
edit: true
envKey: ACCESS_TOKEN
labelZh: 访问令牌
labelEn: Access Token
labelZh: 参数 ACCESS_TOKEN
labelEn: Parameter ACCESS_TOKEN
label:
en: Access Token
zh: 访问令牌
en: Parameter ACCESS_TOKEN
zh: 参数 ACCESS_TOKEN
required: true
type: text
- default: 0
edit: true
envKey: TEAM_ID
labelZh: 团队 ID
labelEn: Team ID
labelZh: 参数 TEAM_ID
labelEn: Parameter TEAM_ID
label:
en: Team ID
zh: 团队 ID
en: Parameter TEAM_ID
zh: 参数 TEAM_ID
required: true
type: number
- default: 0
edit: true
envKey: RUNNER_ID
labelZh: Runner ID
labelEn: Runner ID
labelZh: 参数 RUNNER_ID
labelEn: Parameter RUNNER_ID
label:
en: Runner ID
zh: Runner ID
en: Parameter RUNNER_ID
zh: 参数 RUNNER_ID
required: true
type: number

View File

@ -4,7 +4,7 @@ networks:
services:
apifox-runner:
image: registry.cn-hangzhou.aliyuncs.com/apifox/self-hosted-general-runner:1.8.1
image: registry.cn-hangzhou.aliyuncs.com/apifox/self-hosted-general-runner:1.9.0
container_name: ${CONTAINER_NAME}
labels:
createdBy: "Apps"

View File

@ -1,60 +1,15 @@
# Apifox Runner
## 产品介绍
自动化测试定时任务、接口导入、Mock 服务
![Apifox Runner](https://file.lifebus.top/imgs/apifox_runner_cover.png)
![](https://img.shields.io/badge/%E6%96%B0%E7%96%86%E8%90%8C%E6%A3%AE%E8%BD%AF%E4%BB%B6%E5%BC%80%E5%8F%91%E5%B7%A5%E4%BD%9C%E5%AE%A4-%E6%8F%90%E4%BE%9B%E6%8A%80%E6%9C%AF%E6%94%AF%E6%8C%81-blue)
## 简介
API 设计、开发、测试一体化协作平台
Apifox = Postman + Swagger + Mock + JMeter
一套系统、一份数据,解决多个 API 工具之间的数据同步问题
只要定义好 API 文档API 调试、API Mock、API 自动化测试即可直接使用,无需再次定义。
API 文档和 API 开发调试使用同一个工具API 调试完成后即可保证和 API 文档定义完全一致。高效、及时、准确!
## 特性
- [x] 可视化 API 设计
- [x] 比 Postman 更强大
- [x] 零门槛实现自动化测试
- [x] 分享&发布 API 文档
- [x] 零配置 Mock 数据
- [x] CI/CD 持续集成
- [x] 数据库操作
- [x] 团队协作
- [x] 支持 HTTP、TCP、RPC
- [x] 数据导入/导出
- [x] 自动生成代码
API 设计、开发、测试一体化协作平台 Apifox 的自托管通用 Runner
## 安装说明
### 应用服务地址
默认值:`https://api.apifox.cn`
部署时推荐填写公网地址,以保证应用在团队中正常运行。
### 访问令牌 (Access Token)
进入 [ApiFox Web 端](https://app.apifox.com/),前往主窗口 `团队资源` >> `通用 Runner` >> `部署通用 Runner` 获取访问令牌
进入 [ApiFox Web 端](https://app.apifox.com/),前往主窗口 `团队资源` >> `通用 Runner` >> `部署通用 Runner` 获取安装必需的参数
![](https://f.pz.al/pzal/2025/08/30/4b0a0b821a644.png)
![](https://f.pz.al/pzal/2025/08/30/914c00ba58d20.png)
### 团队 ID (Team ID)
## 更新
同上
### Runner ID
同上
---
![Ms Studio](https://file.lifebus.top/imgs/ms_blank_001.png)
推荐安装 latest 版本,当你重启 Runner 时Runner 会尝试获取最新版本

View File

@ -4,14 +4,17 @@ additionalProperties:
tags:
- Runtime
- Local
shortDescZh: 自动化测试定时任务、接口导入、Mock 服务
shortDescEn: Automated testing, scheduled tasks, interface import, Mock service
shortDescZh: Apifox 的自托管通用 Runner
shortDescEn: Apifox Self-Hosted Universal Runner
description:
en: Automated testing, scheduled tasks, interface import, Mock service
zh: 自动化测试定时任务、接口导入、Mock 服务
type: runtime
en: Apifox Self-Hosted Universal Runner
zh: Apifox 的自托管通用 Runner
type: tool
crossVersionUpdate: true
limit: 0
website: https://apifox.com/
github: https://apifox.com/
document: https://apifox.com/help/
architectures:
- amd64
- arm64

View File

@ -0,0 +1,66 @@
additionalProperties:
formFields:
- default: "./data"
edit: true
envKey: APIFOX_RUNNER_ROOT_PATH
labelZh: 数据持久化路径
labelEn: Data persistence path
label:
en: Data persistence path
zh: 数据持久化路径
required: true
type: text
- default: 4524
edit: true
envKey: PANEL_APP_PORT_HTTP
labelZh: WebUI 端口
labelEn: WebUI port
label:
en: WebUI port
zh: WebUI 端口
required: true
rule: paramPort
type: number
- default: "https://api.apifox.cn"
edit: true
envKey: SERVER_APP_BASE_URL
labelZh: 参数 SERVER_APP_BASE_URL
labelEn: Parameter SERVER_APP_BASE_URL
label:
en: Parameter SERVER_APP_BASE_URL
zh: 参数 SERVER_APP_BASE_URL
description:
en: Fill in the parameters provided by the website; all remaining parameters follow the same rule.
zh: 填入网站给出的参数,余下参数皆如此
required: true
type: text
- default: ""
edit: true
envKey: ACCESS_TOKEN
labelZh: 参数 ACCESS_TOKEN
labelEn: Parameter ACCESS_TOKEN
label:
en: Parameter ACCESS_TOKEN
zh: 参数 ACCESS_TOKEN
required: true
type: text
- default: 0
edit: true
envKey: TEAM_ID
labelZh: 参数 TEAM_ID
labelEn: Parameter TEAM_ID
label:
en: Parameter TEAM_ID
zh: 参数 TEAM_ID
required: true
type: number
- default: 0
edit: true
envKey: RUNNER_ID
labelZh: 参数 RUNNER_ID
labelEn: Parameter RUNNER_ID
label:
en: Parameter RUNNER_ID
zh: 参数 RUNNER_ID
required: true
type: number

View File

@ -0,0 +1,24 @@
networks:
1panel-network:
external: true
services:
apifox-runner:
image: registry.cn-hangzhou.aliyuncs.com/apifox/self-hosted-general-runner:1.9.0
pull_policy: always
container_name: ${CONTAINER_NAME}
labels:
createdBy: "Apps"
restart: always
networks:
- 1panel-network
ports:
- ${PANEL_APP_PORT_HTTP}:4524
volumes:
- ${APIFOX_RUNNER_ROOT_PATH}/runner:/opt/runner
environment:
- TZ=Asia/Shanghai
- SERVER_APP_BASE_URL=${SERVER_APP_BASE_URL}
- TEAM_ID=${TEAM_ID}
- RUNNER_ID=${RUNNER_ID}
- ACCESS_TOKEN=${ACCESS_TOKEN}