多环境REST API测试：如何将JSON配置文件导入karate-config.js

我来帮你搞定这个多环境配置的需求！把所有环境的测试数据和端点统一存在JSON文件里，再通过karate.env参数动态加载是非常合理的实践，下面一步步给你讲清楚怎么实现：

1. 修正并完善你的JSON配置文件 #

首先你提供的JSON格式有问题，建议改成键值对结构（每个环境作为一个键），这样更容易通过环境名直接取值。比如创建一个config.json文件，放在src/test/resources目录下（Karate默认会从这里读取文件）：

{
  "qa": {
    "username_cm_on": "test_cm_qa_user",
    "baseUrl": "https://qa-api.your-domain.com",
    "password": "qa-test-pass"
  },
  "staging": {
    "username_cm_on": "test_cm_staging_user",
    "baseUrl": "https://staging-api.your-domain.com",
    "password": "staging-test-pass"
  },
  "uat": {
    "username_cm_on": "test_cm_uat_user",
    "baseUrl": "https://uat-api.your-domain.com",
    "password": "uat-test-pass"
  },
  "prod": {
    "username_cm_on": "prod_cm_user",
    "baseUrl": "https://api.your-domain.com",
    "password": "prod-secure-pass"
  }
}

这样每个环境的独立配置都清晰归类，后续新增环境直接加键值对就行。

2. 修改karate-config.js加载对应环境配置 #

Karate的karate-config.js是全局配置入口，在这里读取JSON文件并根据karate.env参数筛选配置：

function fn() {
  // 读取JSON配置文件，路径根据实际存放位置调整
  const allEnvConfigs = read('config.json');
  
  // 获取命令行传入的环境参数，默认使用qa环境（防止未传参时出错）
  const currentEnv = karate.env || 'qa';
  
  // 取出当前环境的配置，如果不存在则抛出错误提示
  const activeConfig = allEnvConfigs[currentEnv];
  if (!activeConfig) {
    karate.fail(`错误：未找到环境 "${currentEnv}" 的配置，请检查config.json文件`);
  }
  
  // 返回最终配置，可添加全局通用配置（比如超时、通用headers等）
  return {
    ...activeConfig, // 展开当前环境的所有配置
    env: currentEnv, // 把当前环境名也返回，方便用例中引用
    requestTimeout: 30000, // 全局请求超时时间
    commonHeaders: {
      'Content-Type': 'application/json'
    }
  };
}

这里用到了Karate内置的read()函数，它会自动把JSON文件解析成JavaScript对象，非常省心。

3. 命令行指定环境运行 #

通过-Dkarate.env参数指定要运行的环境，比如：

Maven运行示例 #

mvn test -Dkarate.env=staging

Gradle运行示例 #

gradle test -Dkarate.env=uat

如果不指定参数，会自动使用我们在配置里设置的默认环境qa。

4. 在测试用例中引用配置 #

在.feature文件里直接通过#(变量名)引用配置，比如：

Feature: CM用户登录API测试

Scenario: 验证合法用户登录成功
    Given url baseUrl + '/auth/login'
    And headers commonHeaders
    And request { username: '#(username_cm_on)', password: '#(password)' }
    When method post
    Then status 200
    And match response.token != null

额外注意事项 #

• 敏感信息处理：密码这类敏感数据不建议硬编码在JSON里，可以改用系统环境变量，比如process.env.QA_PASSWORD，在karate-config.js里读取后赋值给配置。
• 路径问题：如果config.json不在默认资源目录，要调整read()的路径，比如放在src/test/resources/configs下，就写成read('configs/config.json')。
• 复杂配置逻辑：如果某些环境需要特殊处理（比如不同的请求拦截器），可以在karate-config.js里通过if-else针对特定环境添加逻辑。

内容的提问来源于stack exchange，提问作者Khaja Mohammed