Processed apps directory via GitHub Actions

This commit is contained in:
QYG2297248353 2024-12-26 03:50:15 +00:00
parent 7779fb617a
commit 41cb42cdde
15 changed files with 247 additions and 0 deletions

View File

@ -0,0 +1,56 @@
# 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] 自动生成代码
## 安装说明
### 应用服务地址
默认值:`https://api.apifox.cn`
部署时推荐填写公网地址,以保证应用在团队中正常运行。
### 访问令牌 (Access Token)
请在ApiFox客户端前往主窗口 `团队资源` >> `通用 Runner` 获取访问令牌
### 团队 ID (Team ID)
请在ApiFox客户端前往主窗口 `团队设置` 获取团队 ID
### Runner ID
请在ApiFox客户端前往主窗口 `团队资源` >> `通用 Runner` 获取 Runner ID
---
![Ms Studio](https://file.lifebus.top/imgs/ms_blank_001.png)

View File

@ -0,0 +1,14 @@
additionalProperties:
key: apifox-runner
name: Apifox Runner
tags:
- Runtime
- Local
shortDescZh: 自动化测试定时任务、接口导入、Mock 服务
shortDescEn: Automated testing, scheduled tasks, interface import, Mock service
type: runtime
crossVersionUpdate: true
limit: 0
website: https://apifox.com/
github: https://apifox.com/
document: https://apifox.com/help/

View File

@ -0,0 +1,18 @@
# 数据持久化路径 [必填]
APIFOX_RUNNER_ROOT_PATH=/home/apifox-runner
# WebUI 端口 [必填]
PANEL_APP_PORT_HTTP=4524
# 应用服务地址 [必填]
SERVER_APP_BASE_URL=http://127.0.0.1:4524
# 访问令牌 [必填]
ACCESS_TOKEN=
# 团队 ID [必填]
TEAM_ID=0
# Runner ID [必填]
RUNNER_ID=0

View File

@ -0,0 +1,47 @@
additionalProperties:
formFields:
- default: "/home/apifox-runner"
edit: true
envKey: APIFOX_RUNNER_ROOT_PATH
labelZh: 数据持久化路径
labelEn: Data persistence path
required: true
type: text
- default: 4524
edit: true
envKey: PANEL_APP_PORT_HTTP
labelZh: WebUI 端口
labelEn: WebUI port
required: true
rule: paramPort
type: number
- default: "http://127.0.0.1:4524"
edit: true
envKey: SERVER_APP_BASE_URL
labelZh: 应用服务地址
labelEn: App Server address
required: true
type: text
- default: ""
edit: true
envKey: ACCESS_TOKEN
labelZh: 访问令牌
labelEn: Access Token
required: true
type: text
- default: 0
edit: true
envKey: TEAM_ID
labelZh: 团队 ID
labelEn: Team ID
required: true
rule: paramPort
type: number
- default: 0
edit: true
envKey: RUNNER_ID
labelZh: Runner ID
labelEn: Runner ID
required: true
rule: paramPort
type: number

View File

@ -0,0 +1,21 @@
networks:
1panel-network:
external: true
services:
apifox-runner:
container_name: apifox-runner
env_file:
- ./envs/global.env
- .env
environment:
- TZ=Asia/Shanghai
image: apifox/self-hosted-general-runner:latest
labels:
createdBy: Apps
networks:
- 1panel-network
ports:
- ${PANEL_APP_PORT_HTTP}:4524
restart: always
volumes:
- ${APIFOX_RUNNER_ROOT_PATH}/runner:/opt/runner

View File

@ -0,0 +1,2 @@
# copyright© 2024 XinJiang Ms Studio
ENV_FILE=.env

View File

@ -0,0 +1,2 @@
# copyright© 2024 XinJiang Ms Studio
TZ=Asia/Shanghai

View File

@ -0,0 +1,17 @@
#!/bin/bash
if [ -f .env ]; then
source .env
# setup-1 add default values
CURRENT_DIR=$(pwd)
sed -i '/^ENV_FILE=/d' .env
sed -i '/^GLOBAL_ENV_FILE=/d' .env
echo "ENV_FILE=${CURRENT_DIR}/.env" >> .env
echo "GLOBAL_ENV_FILE=${CURRENT_DIR}/envs/global.env" >> .env
echo "Check Finish."
else
echo "Error: .env file not found."
fi

View File

@ -0,0 +1,10 @@
#!/bin/bash
if [ -f .env ]; then
source .env
echo "Check Finish."
else
echo "Error: .env file not found."
fi

View File

@ -0,0 +1,17 @@
#!/bin/bash
if [ -f .env ]; then
source .env
# setup-1 add default values
CURRENT_DIR=$(pwd)
sed -i '/^ENV_FILE=/d' .env
sed -i '/^GLOBAL_ENV_FILE=/d' .env
echo "ENV_FILE=${CURRENT_DIR}/.env" >> .env
echo "GLOBAL_ENV_FILE=${CURRENT_DIR}/envs/global.env" >> .env
echo "Check Finish."
else
echo "Error: .env file not found."
fi

Binary file not shown.

After

Width:  |  Height:  |  Size: 79 KiB

18
dockge/apifox-runner/.env Normal file
View File

@ -0,0 +1,18 @@
# 数据持久化路径 [必填]
APIFOX_RUNNER_ROOT_PATH=/home/apifox-runner
# WebUI 端口 [必填]
PANEL_APP_PORT_HTTP=4524
# 应用服务地址 [必填]
SERVER_APP_BASE_URL=http://127.0.0.1:4524
# 访问令牌 [必填]
ACCESS_TOKEN=
# 团队 ID [必填]
TEAM_ID=0
# Runner ID [必填]
RUNNER_ID=0

View File

@ -0,0 +1,21 @@
networks:
1panel-network:
external: true
services:
apifox-runner:
container_name: apifox-runner
env_file:
- ./envs/global.env
- .env
environment:
- TZ=Asia/Shanghai
image: apifox/self-hosted-general-runner:latest
labels:
createdBy: Apps
networks:
- 1panel-network
ports:
- ${PANEL_APP_PORT_HTTP}:4524
restart: always
volumes:
- ${APIFOX_RUNNER_ROOT_PATH}/runner:/opt/runner

View File

@ -0,0 +1,2 @@
# copyright© 2024 XinJiang Ms Studio
ENV_FILE=.env

View File

@ -0,0 +1,2 @@
# copyright© 2024 XinJiang Ms Studio
TZ=Asia/Shanghai