跳转到内容

接口管理

AngusTester接口管理功能支持全流程管理API生命周期,实现从创建、测试到文档化的高效协作,提升接口开发与测试效率。

一、接口基础操作

1. 添加HTTP接口

操作说明:创建标准HTTP协议接口
操作步骤

  1. 导航至 接口 → 服务
  2. 点击「添加HTTP接口」按钮
  3. 配置请求方法、路径、参数
  4. 点击「发送请求」调试接口
  5. 点击「归档」保存接口

⚠️ 调试提示:发送请求前确保参数配置正确

2. 添加WebSocket接口

操作说明:创建WebSocket协议接口
操作步骤

  1. 导航至 接口 → 服务
  2. 点击「添加WebSocket接口」按钮
  3. 配置路径、参数
  4. 点击「归档」保存接口

3. 添加未归档接口

操作说明:创建临时调试接口(仅创建者可见)
操作步骤

  1. 导航至 接口 → 服务
  2. 点击「添加HTTP接口」按钮
  3. 配置请求参数
  4. 点击「保存到未归档」

二、接口管理操作

1. 编辑接口

操作说明:修改接口配置参数
操作步骤

  1. 双击目标接口
  2. 修改请求配置
  3. 点击「保存」

2. 克隆接口

操作说明:快速复制接口配置
操作步骤

  1. 选中目标接口
  2. 点击「克隆」按钮
  3. 修改新接口配置
  4. 点击「保存」

3. 移动接口

操作说明:转移接口至其他服务
操作步骤

  1. 选中目标接口
  2. 点击「移动」按钮
  3. 选择目标服务
  4. 确认移动

4. 导出接口

操作说明:导出接口定义用于备份或共享
操作步骤

  1. 选中目标接口
  2. 点击「导出」按钮
  3. 文件自动下载到本地

5. 修改接口状态

操作说明:更新接口开发状态
支持状态

  • 设计中
  • 开发中
  • 开发完成
  • 已发布

操作步骤

  1. 选中目标接口
  2. 点击「修改状态」
  3. 选择新状态

⚠️ 权限要求:修改为已发布状态需「发布」权限

6. 关注接口

操作说明:标记接口接收变更通知
操作步骤

  1. 选中目标接口
  2. 点击「关注」按钮

⚠️ 通知机制:关注后接口变更会收到通知

7. 收藏接口

操作说明:添加接口至快捷访问列表
操作步骤

  1. 选中目标接口
  2. 点击「收藏」按钮

三、接口测试管理

1. 生成测试脚本

操作说明:创建各类自动化测试脚本
操作步骤

  1. 选中目标接口
  2. 点击「测试脚本→生成测试脚本」
  3. 选择测试类型
  4. 配置执行参数

⚠️ 限制说明

  • 每种测试类型仅允许一个脚本
  • 重新生成需先删除旧脚本

2. 执行功能测试

操作说明:验证接口业务逻辑正确性
操作步骤

  1. 选中目标接口
  2. 点击「执行测试→执行功能测试」
  3. 配置服务器环境
  4. 执行模块查看结果

3. 执行稳定性测试

操作说明:验证高负载下接口稳定性
操作步骤

  1. 选中目标接口
  2. 点击「执行测试→执行稳定性测试」
  3. 配置服务器环境
  4. 执行模块查看结果

4. 执行性能测试

操作说明:测试接口吞吐量与响应时间
操作步骤

  1. 选中目标接口
  2. 点击「执行测试→执行性能测试」
  3. 配置服务器环境
  4. 执行模块查看结果

5. 管理测试用例

操作说明:全面管理接口测试用例
包含操作

  • 添加用例(点击「添加」配置参数)
  • 编辑用例(点击「编辑」修改配置)
  • 克隆用例(点击「克隆」创建副本)
  • 删除用例(点击「删除」移除)
  • 执行用例(点击「执行测试」验证功能)

⚠️ 参数配置:使用变量/数据集时需提前声明关联

四、接口文档化

1. 生成Mock接口

操作说明:创建接口模拟版本
操作步骤

  1. 选中目标接口
  2. 点击「Mock接口」→「生成Mock接口」
  3. 选择Mock服务
  4. 输入接口名称

2. 关联Mock接口

操作说明:绑定现有模拟服务
操作步骤

  1. 选中目标接口
  2. 点击「Mock接口」→「关联Mock接口」
  3. 选择关联服务
  4. 确认关联

3. 生成客户端代码

操作说明:获取多语言调用示例
操作步骤

  1. 选中目标接口
  2. 打开「代码」标签页
  3. 选择编程语言
  4. 复制生成的调用代码

五、测试任务管理

1. 生成测试任务

操作说明:创建接口测试追踪任务
操作步骤

  1. 选中目标接口
  2. 点击「测试任务→生成测试任务」
  3. 填写迭代/经办人/截止时间
  4. 任务模块跟踪任务

2. 管理测试任务

操作说明:全面管理测试任务状态
支持操作

操作类型功能说明注意事项
重新打开重置为待处理状态保持原任务指标
重新开始重置为待处理状态清空任务指标
删除移除任务不可恢复

⚠️ 状态限制:仅适用于已完成/已取消状态的任务

六、其他功能

1. 配置请求代理

操作说明:设置跨域请求代理
操作步骤

  1. 选中目标接口
  2. 打开「代理」配置
  3. 选择代理类型

⚠️ 生效范围:仅对当前用户生效

2. 查看测试结果

操作说明:检查接口测试执行情况
操作步骤

  1. 选中目标接口
  2. 打开「测试结果」标签页

3. 查看活动记录

操作说明:审计接口操作历史
操作步骤

  1. 选中目标接口
  2. 打开「活动」标签页

基于 GPL-3.0 许可发布