跳到主要内容

环境变量使用

在 Hapydev 中，环境变量是一种存储在特定环境中的值。您可以创建多个环境，并且每个环境都可以包含多个变量。

为什么需要环境变量​

环境变量对于 API 测试和开发至关重要，因为它们使您能够将通用值或参数化信息与您的 API 请求相关联。这有助于减少测试的重复性并提高效率。

使用方式​

Hapydev 提供了多种环境变量的使用方式：

  1. 预设值:在 Hapydev 中，您可以为某些环境变量指定预设值。当您使用这些变量时，hapydev 将自动将这些预设值赋予给该变量。
  2. 直接引用:可以在请求的 URL、请求header、Query或Body中直接引用环境变量。这使您能够快速地将同样的值应用到您的 API 请求中。
  3. 脚本支持:可以通过脚本操作操作提取或修改环境变量值，将前一个接口的返回数据用于下一个接口的入参，例如获取token进行验证等。

一般步骤​

以下是关于在 Hapydev 中使用环境变量的一般步骤：

  1. 创建环境变量:首先，必须拥有一个该场景下运行环境。在该环境中，您可以添加多个变量和预设值。
  2. 定义变量名称:给您的每个变量赋予一个明确且易于识别的名称。这样您就能够轻松地在请求中引用它们。
  3. 为变量设置值:将所需值分配给您的环境变量，这些值可以来自外部源、数据库或计算表达式等。
  4. 使用环境变量:当您运行一个接口请求或执行自动化测试用例时，可以引用环境变量名称。

最佳实践​

  • 使用标准命名:使用明确且一致的命名规范来表示您的环境变量。例如，可以在变量名前添加“ENV_”或“APP_”，以便其他开发人员能够快速识别它们所代表的含义。
  • 为变量赋予相关描述:为每个环境变量赋予一个简短但清晰的描述，表明其作用域、使用目的或与其他变量之间的关系。这样您和其他开发人员就能够更好地理解它们所代表的含义。
  • 避免重复代码:尽可能地将环境变量应用到您的 API 请求中，以减少重复代码。通过使用同样的变量，您可以方便地更改整个测试场景中的值，而不是分别修改每个请求。
  • 使用预设值:为一些常用的环境变量指定预设值，以便在需要时能够快速应用这些值。这种方法使您能够提高效率并减少手动输入的次数。
  • 遵循命名约定:遵守某些标准的命名约定，例如大小写敏感性或以下划线 (_) 或横杠 (-) 的命名。这样您的变量名称将更易于识别和理解。

通过执行这些实践，您将能够使 Hapydev 环境变量成为 API 测试的一个强大工具，并且提高了开发人员之间的沟通效率。

下面是一个例子：

// 变量定义
ENV_API_KEY = 'your_api_key'
APP_BASE_URL = 'https://api.example.com'

// 请求体中使用环境变量
{
    "key": ENV_API_KEY,
    "url": APP_BASE_URL + '/resources',
}

// 在同一个请求中多次使用相同的变量名避免重复代码
{
    "key": ENV_API_KEY,
    "value1": '${APP_BASE_URL}/path/to/resource/1',
    "value2": '${APP_BASE_URL}/path/to/resource/2'
}
最后由 hapydevlab 于 更新