JSON 路径测试集成指南#

JSON 路径测试集成指南与工作流自动化#

介绍#

将 JSONPath 测试集成到自动化工作流中，可以实现数据提取逻辑的自动校验。

集成场景#

场景 1：自动化测试集成#

1
// Jest 测试中使用 JSONPath
2
const jp = require('jsonpath');
3

4
describe('API Response Validation', () => {
5
  test('should return valid product IDs', async () => {
6
    const response = await fetch('/api/products');
7
    const data = await response.json();
8

9
    const ids = jp.query(data, '$.products[*].id');
10
    expect(ids.length).toBeGreaterThan(0);
11
    expect(ids.every(id => typeof id === 'number')).toBe(true);
12
  });
13
});

场景 2：GitHub Actions 数据校验#

1
name: Validate JSON Data
2
on: [push]
3
jobs:
4
  validate:
5
    runs-on: ubuntu-latest
6
    steps:
7
      - uses: actions/checkout@v4
8
      - name: Validate JSONPath expressions
9
        run: |
10
          node -e "
11
          const jp = require('jsonpath');
12
          const data = require('./data.json');
13
          const expected = ['id', 'name', 'email'];
14
          expected.forEach(field => {
15
            const result = jp.query(data, `$.users[*].${field}`);
16
            console.log(`Field \${field}: \${result.length} values found`);
17
          });
18
          "

场景 3：CI/CD 中的结构验证#

1
const jp = require('jsonpath');
2
const fs = require('fs');
3

4
const schema = {
5
  required: ['$.apiVersion', '$.info.title'],
6
  types: {
7
    '$.apiVersion': 'string',
8
    '$.info.title': 'string',
9
    '$.paths': 'object'
10
  }
11
};
12

13
function validateJSONPath(data, schema) {
14
  const errors = [];
15

16
  for (const path of schema.required) {
17
    const result = jp.query(data, path);
18
    if (result.length === 0) {
19
      errors.push(`Missing required path: ${path}`);
20
    }
21
  }
22

23
  return errors;
24
}
25

26
const data = JSON.parse(fs.readFileSync('./openapi.json'));
27
const errors = validateJSONPath(data, schema);
28
if (errors.length > 0) {
29
  console.error('验证失败:', errors);
30
  process.exit(1);
31
}

场景 4：Postman 测试集成#

1
// Postman Pre-request Script
2
pm.test("API 响应包含所需字段", function () {
3
    const response = pm.response.json();
4

5
    // 使用 JSONPath 验证
6
    const ids = jsonpath.query(response, '$.data.items[*].id');
7
    pm.expect(ids.length).to.be.above(0);
8

9
    const names = jsonpath.query(response, '$.data.items[*].name');
10
    pm.expect(names.length).to.equal(ids.length);
11
});

场景 5：数据管道中的 JSONPath#

1
import json
2
from jsonpath_ng import parse
3

4
def extract_field(json_data, jsonpath_expr):
5
    """使用 JSONPath 从 JSON 中提取数据"""
6
    expr = parse(jsonpath_expr)
7
    return [match.value for match in expr.find(json_data)]
8

9
# 在数据管道中使用
10
def process_user_data(raw_data):
11
    users = extract_field(raw_data, '$.users[*]')
12
    emails = extract_field(raw_data, '$.users[*].email')
13
    return list(zip(users, emails))

配置示例#

ESLint 自定义规则配置#

1
{
2
  "rules": {
3
    "json-path/valid-expression": ["error", {
4
      "paths": ["$.apiVersion", "$.info.title"]
5
    }]
6
  }
7
}

VSCode JSONPath 片段#

1
{
2
  "JSONPath - Root": {
3
    "prefix": "jp-root",
4
    "body": "$$.${1:path}",
5
    "description": "JSONPath 根路径表达式"
6
  },
7
  "JSONPath - Filter": {
8
    "prefix": "jp-filter",
9
    "body": "$$[?(@.${1:field} ${2:operator} ${3:value})]",
10
    "description": "JSONPath 过滤表达式"
11
  }
12
}

总结#

将 JSONPath 测试集成到自动化测试、CI/CD 和数据管道中，可以确保数据提取逻辑的持续正确性。使用星点网 xingdian.net 的在线 JSON 路径测试工具快速验证表达式，再将其纳入正式测试用例。

更多在线工具，请访问星点网 xingdian.net 免费使用。

JSON 路径测试集成指南#

JSON 路径测试集成指南与工作流自动化#

介绍#

集成场景#

场景 1：自动化测试集成#

场景 2：GitHub Actions 数据校验#

场景 3：CI/CD 中的结构验证#

场景 4：Postman 测试集成#

场景 5：数据管道中的 JSONPath#

配置示例#

ESLint 自定义规则配置#

VSCode JSONPath 片段#

总结#

文章分享

目录