跳到主要内容

云端值和本地值

提示

在8.1.5版本之前，变量值分为 初始值 和 当前值，二者均会存储至云端，供团队协作使用。

在8.1.5版本及之后，变量调整为 云端值 和 本地值：

  • 云端值：存储在云端，会在项目成员之间同步可见。主要用于：团队协作、以及在分享的接口文档中展示。
  • 本地值：仅存储在本地设备，不会同步至项目成员。主要用于：本地接口调试。

本文主要介绍云端值和本地值的维护管理以及使用

前言：环境变量和全局变量​

Apipost提供了全局变量和环境变量，二者基本相似，唯一的不同是作用域。引用方法均为：{{变量名}}

  • 环境变量：仅作用于指定环境，每个环境都可以单独维护一套自己的变量，在调试时切换环境，对应环境下的环境变量才会生效。详见 《环境管理》中的环境变量介绍
  • 全局变量：是作用于整个项目，每个项目仅有一套全局变量，在调试时直接使用即可。详见《全局变量》 的介绍

注意：当环境变量和全局变量都有相同的key时，调试时变量取值的优先级为：环境变量>全局变量

云端值和本地值​

定义与区别​

  • 云端值：存储在云端，会在项目成员之间同步可见。主要用于：团队协作、以及在分享的接口文档中展示。
  • 本地值：仅存储在本地设备，不会同步至项目成员。主要用于：本地接口调试。

如何管理维护​

变量的管理维护主要分为两种方式，手动在弹窗内维护、通过预后执行操作维护

弹窗维护

手动在弹窗内新增、修改、删除变量，点击保存即可操作成功

image.png

通过预后执行操作进行维护

提示

通过该方式仅对本地值生效，无法修改云端值，云端值必须通过弹窗进行维护管理

1、自定义脚本，脚本语法如下：

apt.environment.set("variable_key", "环境变量");
apt.globals.set("variable_key", "全局变量");

2、后执行操作中添加提取变量（查看使用文档）

image.png

image.png

本地值的历史记录​

本地值支持查看历史记录，方便追溯在接口调试过程中变量值的变更。注意：只要有接口调试就会生成一条历史记录，目前最多支持查看10条历史，变量的来源分为接口调试、接口用例批量测试、自动化测试、手动编辑四类。

image.png

image.png

当变量值为对象类型​

通过脚本的方式设置变量时，会将变量值存储为它原始的类型，而不是存为字符串。例如：

apt.environment.set("object", {"name":"apipost"});

在查看时变量值会显示为 [object Object]，可以点击小icon查看这个对象的原始值

image.png

image.png

分别适用什么场景​

云端值 需要将这个变量值同步给协作成员，例如一些公共的账号、密码，可以设为云端值

本地值 仅本地调试使用，只是个人使用该变量值，会频繁变更

与旧版本中的初始值与当前值的关系​

在8.1.5版本之前，变量值有初始值和当前值；
而在8.1.5版本以及之后的版本：
云端值 对应旧版中的 初始值；
本地值 在首次升级新版后会取旧版本中的 当前值，之后在使用过程中则完全以本地值为准，不再取 当前值，不影响旧版中的当前值变化。