JSON Schema 验证集成指南与工作流自动化#

介绍#

单一的 JSON Schema 验证工具可以满足临时需求，但真正发挥其威力的是将其整合到开发流水线和自动工作流中。本文介绍 4 个核心集成方案。

集成场景#

场景一：集成到 Pre-commit Hook#

在代码提交前自动验证项目中的 JSON 配置文件：

1
repos:
2
  - repo: local
3
    hooks:
4
      - id: validate-json-schema
5
        name: Validate JSON config files
6
        entry: node validate-schema.js
7
        language: node
8
        files: \.json$

1
const Ajv = require('ajv');
2
const ajv = new Ajv();
3
const fs = require('fs');
4

5
const schema = JSON.parse(fs.readFileSync('schema/api-schema.json'));
6
const data = JSON.parse(fs.readFileSync(process.argv[2]));
7

8
const validate = ajv.compile(schema);
9
if (!validate(data)) {
10
  console.error(validate.errors);
11
  process.exit(1);
12
}

场景二：集成到 CI Pipeline#

在自动化构建流程中添加验证步骤：

1
- name: Validate API responses
2
  run: |
3
    npm install ajv
4
    for file in test-data/*.json; do
5
      node -e "
6
        const Ajv = require('ajv');
7
        const ajv = new Ajv();
8
        const schema = require('./schema.json');
9
        const data = require('./$file');
10
        const valid = ajv.validate(schema, data);
11
        if (!valid) { console.log('$file:', ajv.errors); process.exit(1); }
12
        console.log('$file: ✓');
13
      "
14
    done

场景三：Express 中间件验证#

在 Express.js 应用中集成 Schema 验证中间件：

1
const Ajv = require('ajv');
2
const ajv = new Ajv();
3

4
function validateSchema(schema) {
5
  const validate = ajv.compile(schema);
6
  return (req, res, next) => {
7
    if (!validate(req.body)) {
8
      return res.status(400).json({
9
        error: 'Validation failed',
10
        details: validate.errors
11
      });
12
    }
13
    next();
14
  };
15
}
16

17
app.post('/api/users', validateSchema(userSchema), createUser);

场景四：MongoDB Schema 验证集成#

直接使用 JSON Schema 定义 MongoDB 集合的文档验证规则：

1
db.createCollection('orders', {
2
  validator: {
3
    $jsonSchema: {
4
      bsonType: 'object',
5
      required: ['orderId', 'amount', 'status'],
6
      properties: {
7
        orderId: { bsonType: 'string' },
8
        amount: { bsonType: 'number', minimum: 0 },
9
        status: { enum: ['pending', 'paid', 'shipped', 'cancelled'] }
10
      }
11
    }
12
  }
13
});

总结#

将 JSON Schema 验证集成到开发流程的各个环节，可以在”上游”及早发现数据问题，而不是等到系统崩溃时才追查。利用星点网 JSON Schema 验证器调试和确认你的验证规则，然后将这些规则无缝部署到 CI/CD、中间件和数据库层，构建全链路数据质量保障体系。

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