Apifox 使用文档

vuePress-theme-reco Apifox 使用文档    2021
Apifox 使用文档 Apifox 使用文档

Choose mode

  • dark
  • auto
  • light
文档
建议反馈
下载 Apifox

Apifox 使用文档

0

Article

0

Tag

文档
建议反馈
下载 Apifox
  • 介绍

    • Apifox 介绍
    • 快速上手
  • 接口管理

    • 接口设计 (接口文档)
    • 接口调试 / 接口用例
    • 数据结构 / 数据模型
    • 快捷调试
    • 环境管理
    • 环境变量 / 全局变量 / 本地变量
    • 动态变量 / 随机参数
  • Socket 接口

    • Socket 接口快速上手
    • 报文数据处理器
  • 最佳实践

    • 团队协作流程
    • 接口之间如何传递数据
    • 登录态(Auth)如何处理
    • 接口签名如何处理
  • 使用脚本

    • 脚本介绍
    • 预执行脚本
    • 后执行脚本 (断言测试)
    • 公共脚本
    • 脚本 API 参考

      • pm 对象 API
      • 内置 JS 类库
      • 脚本调用其他语言( java、python、php 等)
    • 脚本示例

      • 断言 (测试请求结果)
      • 脚本使用变量
      • 脚本读取/修改接口请求信息
      • 其他示例
  • Mock 数据

    • Mock 功能说明
    • Mock 语法
    • 智能 Mock
  • 测试管理

    • 测试用例
    • 测试套件
    • 性能测试
    • 对比测试 (todo)
  • 持续集成

    • 持续集成
  • 代码生成

    • 代码生成
  • 导入/导出

    • 导入数据
    • 导入抓包数据 (cURL)
    • 导出数据
  • Apifox CLI

    • Apifox CLI 命令行运行
  • Apifox API

    • Apifox 开放 API (todo)
  • 插件

    • 插件安装、开发 (todo)
    • 数据导入插件 (todo)
    • 数据导出插件 (todo)
  • 更多功能

    • 快捷键
    • 私有化部署
  • 参考资料

    • JSON Schema 介绍
    • Socket 粘包和分包问题
    • 安装 Java 环境
  • 其他

    • 常见问题
    • 后续功能规划
    • 更新日志
    • 联系我们

vuePress-theme-reco Apifox 使用文档    2021

公共脚本


Apifox 使用文档

# 公共脚本

公共脚本主要用途是实现脚本复用,避免多处重复编写相同功能的脚本。

您可以将多处都会用到的相同功能的脚本或者通用的类、方法,放到公共脚本里,然后所有接口直接引用公共脚本即可使用。

# 使用方式

# 管理公共脚本

打开项目设置->公共脚本,在这里管理公共脚本。

# 引用公共脚本

接口运行界面或接口用例界面的预执行脚本和后直接脚本,可直接引用公共脚本。

注意

  • 公共脚本是在普通脚本之前执行的。
  • 多个公共脚本执行顺序和添加的顺序保持一致。

# 普通脚本调用公共脚本

脚本之间是可以做到相互调用的,使用场景:

  • 普通脚本需要调用公共脚本里的变量或者方法。
  • 公共脚本之间相互调用。
  • 后执行脚本和调用预执行脚本。

为了避免脚本之间的变量冲突,所有脚本执行的时候都是在各自的作用域(通过闭包包裹)下运行的,而使用var、let、const、function 声明的变量或者方法都是 局部变量或局部方法,所以是不能被其他脚本调用的。如果想要变量或方法被其他脚本调用,需要改成全局变量或全局方法。

变量示例:

// 声明局部变量,无法被其他脚本调用
var my_var = "hello";

要改成

// 声明全局变量,可以被其他脚本调用
my_var = 'hello';

方法示例:

// 声明局部方法,无法被其他脚本调用
function my_fun(name) {
  console.log('hello' + name);
}

要改成

// 声明全局方法,可以被其他脚本调用
my_fun = function(name) {
  console.log('hello' + name);
};

改成全局变量或者全局方法后即可被其他脚本之间调用。

注意

  • 请务必注意确保不同脚本之间全局变量或者全局方法命名没有冲突。
  • 接口用例,需要在预执行脚本或后执行脚本里添加了公共脚本才能能调用公共脚本。
  • 调用脚本需要注意脚本执行顺序,只有后执行的脚本可以调用先执行的脚本。
  • 使用方式
  • 管理公共脚本
  • 引用公共脚本
  • 普通脚本调用公共脚本