跳到主要内容

快速开始

AREX 服务安装完成后,即可通过浏览器(推荐使用 89 或更高版本的 Chrome 浏览器)访问 AREX 前端页面:

  • 如果未修改端口配置,则直接访问 8088 端口 (Docker Compose 暴露端口 8088) http://0.0.0.0:8088/
  • 如果独立部署前端,且未修改端口的 (缺省端口 8080) http://0.0.0.0:8080/
  • 如果端口做了修改,则按照修改后的端口访问

首次登陆

注册应用

  • 邮箱登录

首次登录需要输入你的个人邮箱,邮箱收到验证码后点击 Login 完成登录。

  • 游客登陆

也可以直接点击下 Guest 链接进行登录,但登录后不具备团队协作功能(即用例分享功能),且不能创建应用。

  • Gitlab 登录

如果配置了 Gitlab 登录,直接点击 Gitlab 标志登录即可。

Chrome 插件安装

插件

注意:在使用前需要根据浏览器提示安装 Chrome 插件,解除浏览器跨域限制。

在跳转出的页面中选择 Add to Chrome 下载插件即可。

插件

如不能访问 Chrome 插件,可通过 Release 下载到本地安装。

  1. 下载 arex-chrome-extension.zip 到本地并解压

    插件

  2. 打开 Chrome 浏览器并输入 chrome://extensions/ 进入扩展程序页面。点击右上角选择开发者模式。再点击 加载已解压的扩展程序 选中刚才解压的文件夹。

    插件

  3. 安装完成。

    安装完成

界面组成

界面概览

AREX 前端页面主要包含页眉、菜单栏、工作台三大区域。

页眉

页眉

点击界面右上角头像:

  • Setting:切换页面暗黑/明亮模式、中/英文模式、上传头像等操作。流量脱敏操作详见 -> 流量脱敏配置
  • Logout:退出当前登录账号。

Settings icon

菜单栏

Sidebar
  • 工作区Workspace
    • 点击下拉菜单切换 Workspace;点击右侧 + 新建一个工作区;
    • 点击编辑工作区图标设置当前工作区。
  • Collection:查看常规测试用例和比对测试用例。
    • +:新建一个请求集合。
    • 导入导出导入导出按钮:将用例集合(目前仅支持 Postman 格式)导入至 AREX,或将 AREX 用例进行导出。Sidebar
    • 批量运行批量运行:批量运行多个测试用例。
  • App:查看、创建应用,进行回放测试。

工作台

工作台是进行接口测试、回放测试、比对测试等操作时的主要区域。标签栏可以快速管理各种请求、集合、回放,右上角可以快捷选择环境。

工作台

切换环境

根据需要,可以在页面右上角,快速切换为你所需要的环境。选中相应的环境,即可访问该环境中的变量。

切换环境

新建集合

通过建立集合将各类请求进行分组管理,可以帮助你更好地管理请求。

点击左侧菜单栏 CollectionCreate new collection 按钮,新建一个集合:

新建集合

创建完成后,可以在左侧菜单栏管理集合。集合下还可以新增子集/文件夹。

New Collection

新建工作区

首次登陆时将进入默认工作区。你可以创建不同的工作区供自己使用,也可以邀请你的团队在你的工作区中协作管理 Collection、共享 Environment 等。

  1. 点击菜单栏右上方的 “+” 图标可以新建一个工作区。

    New workspace
  2. 在左侧输入框中为你的工作区命名并点击 “” 图标完成创建。

    Save
  3. 点击编辑按钮编辑工作区。

    Overview:管理员可以在这里修改工作区的名称、查看团队成员并修改成员权限、删除工作区。

    编辑工作区

    Labels:管理员及可编辑成员可在该页面添加测试用例标签,方便管理测试用例。

    管理标签

协作功能

AREX 提供协作功能,你可以邀请其他人加入你的工作区,在同个工作区中进行在线协作。加入工作区的成员可以共享环境、Collection 中测试集合及测试用例等资源。如需邀请成员加入某工作区:

  1. 在左上角切换至需要进行协作的工作区。

    Invite
  2. 点击工作区编辑按钮,通过邮箱来邀请你的团队成员加入当前工作区。填写对方邮箱并为其设置权限后,点击 Send Invites 发送邀请,随后邀请人员将接收到邀请邮件,点击邮件中链接即可接受邀请,加入到工作区中。

    编辑工作区

    权限分为管理员(Admin)、可编辑成员(Editor)、只读成员(Viewer)三种类型。

    Invite

    其中:

    • Admin:管理员权限,可以管理工作区中详细信息、删除工作区、并可为成员设置权限。
    • Editor:可以创建并编辑工作区中的资源(如测试用例)。
    • Viewer:不可对工作区中数据进行编辑操作,可以查看和导出工作区的资源。

新建请求

你可通过 AREX 创建并发送接口请求,进行常规测试。

若要创建新请求,可以先创建新集合,点击集合右侧下拉菜单新建一个请求:

Invite

输入接口 URL 及参数,即可快速发送请求:

发送请求