arexadmin01/arex Docker 镜像 - 轩辕镜像

AREX UI 镜像文档

镜像概述

AREX UI 是开源项目 AREX 的前端界面组件，为 API 自动化测试提供可视化操作平台。该镜像基于 arextest 开源项目构建，主要用于简化 API 测试流程，支持用户通过直观的界面管理测试用例、配置测试参数、执行测试任务及查看测试结果，核心能力是结合真实数据实现高效的 API 自动化测试。

核心功能和特性

• 开源免费：基于 MIT 许可证开源，代码托管于 GitHub，支持社区贡献与二次开发
• 真实数据测试：支持集成真实业务数据进行 API 测试，提升测试场景的真实性和有效性
• 可视化操作界面：提供直观的 UI 交互，覆盖测试用例创建、编辑、执行、结果分析等全流程
• API 自动化测试支持：原生支持 API 自动化测试流程，降低手动测试成本，提高测试效率

使用场景和适用范围

• API 测试团队：用于管理和执行 API 自动化测试用例，适合测试工程师日常测试工作
• 开发团队：在研发流程中快速验证 API 功能正确性，支持本地测试与 CI/CD 流程集成
• 中小型技术团队：无需从零构建测试平台，通过现成 UI 组件快速搭建 API 测试体系
• 开源技术爱好者：作为学习或二次开发基础，扩展自定义测试能力

使用方法和配置说明

基础部署（Docker Run）

通过以下命令快速启动 AREX UI 容器：

bash
docker run -d -p 8080:80 --name are*** arextest/are***:latest

参数说明：

• -d：后台运行容器
• -p 8080:80：端口映射，将容器内 80 端口（默认前端服务端口）映射到主机 8080 端口（可根据实际需求调整主机端口）
• --name are***：指定容器名称为 are***
• arextest/are***:latest：使用最新版本的 AREX UI 镜像

环境变量配置

AREX UI 需与后端服务配合使用，可通过环境变量指定后端 API 地址：

bash
docker run -d -p 8080:80 \
  --name are*** \
  -e BACKEND_API_URL=http://{your-backend-service-ip}:{port} \
  arextest/are***:latest

关键环境变量：

• BACKEND_API_URL：AREX 后端服务的访问地址（必填），需根据实际部署的后端服务 IP 和端口配置

扩展部署（Docker Compose）

推荐结合后端服务使用 Docker Compose 编排部署，示例配置（docker-compose.yml）：

yaml
version: '3'
services:
  are***:
    image: arextest/are***:latest
    ports:
      - "8080:80"
    environment:
      - BACKEND_API_URL=[***]
    depends_on:
      - arex-backend
    restart: unless-stopped

  arex-backend:
    image: arextest/arex-backend:latest  # 需替换为实际后端镜像
    ports:
      - "8080:8080"
    # 后端服务其他配置（如数据库连接等）

注意事项

• 部署前需确保后端服务已正常运行，BACKEND_API_URL 配置需指向可用的后端服务地址
• 生产环境建议使用固定版本镜像（如 arextest/are***:v1.0.0），避免自动更新导致兼容性问题
• 如需持久化测试数据，需通过后端服务配置数据存储（如数据库、文件存储等），UI 本身不直接处理数据持久化
• 更多配置细节（如自定义端口、HTTPS 支持等）请参考官方项目文档：[***]