将Sequelize模型转换为JSON Schema以进行用户输入验证

Question

计划使用AJV 用于验证用户输入。 AJV需要数据模型JSON Schema来验证用户输入。因此，我们需要从Sequelize模型派生JSON Schema。有没有办法以编程方式从Sequelize模型中获取JSON schema？

Answer 1

答案很晚，但我最终创建sequelize-to-json-schema来解决这个问题。

它提供了更多自定义功能，包括您在架构中包含的属性以及添加可能由create方法或类似方法使用的虚拟属性。

示例

// assuming you have a user model with the properties
// name (string) and status (enum: real, imagined)
const schemaFactory = require('sequelize-to-json-schema');

const factory = new SchemaFactory({
  customSchema: {
    user: { 
      name: { description: "The user's name" },
      status: { description: 'Was it all just a dream?' },
    },
  }
  hrefBase: 'http://schema.example',
});
const schemaGenerator = factory.getSchemaGenerator(User);
const schema = schemaGenerator.getSchema();

// Results in
schema = {
  {
    title: 'User',
    '$id': 'http://schema.example/user.json',
    type: 'object',
    '$schema': 'http://json-schema.org/draft-06/schema#',
    properties: {
      name: {
        '$id': '/properties/fullname',
        type: 'string',
        examples: [],
        title: 'Name',
        description: "The user's name",
      },
      status: {
        '$id': '/properties/status',
        type: 'string',
        examples: ['REAL', 'IMAGINED'],
        enum: ['REAL', 'IMAGINED'],
        title: 'Status',
        description: 'Was it all just a dream?'
      }
    }
  }
}

注意： sequelize-to-json-schema会生成draft-06模式，与AJV一起使用，他们的自述文件说你需要这样做：

ajv.addMetaSchema(require('ajv/lib/refs/json-schema-draft-06.json'));