ApiTune Docs

中文

English

中文

English

Appearance

代理规则 ​

ApiTune 的代理规则提供强大的请求拦截和操作功能。您可以创建复杂的规则来重定向流量、修改请求/响应或模拟各种网络条件。

添加规则

创建规则 ​

  1. 点击侧边栏的添加规则按钮来创建新的规则配置。

  2. 配置基本规则属性：

    • 规则名称（用于识别）
    • 描述（可选）
    • 匹配模式（用于匹配请求的模式）

  3. 从三个选项中选择匹配类型：

    • URL：匹配完整的 URL
    • Host：匹配主机名部分
    • Path：匹配 URL 路径部分

匹配类型

  1. 选择匹配方法：
    • 包含：模式存在于目标中的任何位置
    • 等于：需要完全匹配
    • 正则匹配：模式解释为正则表达式

匹配方法

TIP

使用测试匹配值功能来验证您的模式匹配。 对话框将显示匹配结果以供验证。

测试匹配值

  1. 配置 HTTP 方法过滤 选择特定的 HTTP 方法来按方法类型过滤请求。 请求方法过滤

  2. 应用规则 使用添加规则下拉菜单来应用一个或多个操作规则。 可以组合多个规则来创建复杂的请求/响应修改。 添加规则

规则管理 ​

启用/禁用规则 ​

使用启用/禁用控件即时切换规则状态。

规则分组 ​

使用规则组管理功能将规则组织成逻辑组。

删除规则 ​

通过删除功能移除不再需要的规则。 删除规则

WARNING

规则删除操作无法撤消。请谨慎操作。

测试和脚本 ​

ApiTune 提供强大的 API 测试和脚本生成功能。 测试和打印脚本

通过测试和脚本标签访问这些功能。

右侧面板包含预构建的测试和打印代码片段。单击即可将它们插入到编辑器中。

测试语法 ​

所有测试代码必须以 at.test 开头。

js
// 测试定义语法
at.test(title: string, fn: () => {
  // 测试实现
})

// 示例
at.test('请求体验证', function() {
  const body = JSON.parse(request.body)
  expect(body.result).to.equal('success')
})

INFO

ApiTune 集成了 Chai 断言库。 参考完整的 Expect API 了解可用的断言。

测试会自动对每个匹配的请求执行。在测试标签中查看结果。

测试结果

打印语法 ​

ApiTune 支持自定义请求日志记录。

打印语法

所有打印语句必须以 at.print 开头。

js
// 基本日志
at.print(log: string)

// 日志级别
at.print.debug('调试信息')
at.print.info('信息消息')
at.print.log('标准日志')
at.print.warn('警告消息')
at.print.error('错误消息')

// 高级日志示例
const list = []
for(let header of Object.keys(response.headers)) {
    list.push({
      value: `响应头: ${header} => ${response.headers[header]}`,
      type: 'log'
    })
}
// 列表样式输出
at.print.list(list);

在打印标签中查看日志输出。

打印结果