json - schema - 综合起来

合并计划 使用全能 合并到一个更可读的 组成计划 不含全能 .
npm install json-schema-merge-allof --save
特征
- 真实 财务报告和审定财务报表 保险 合并计划 全部
- 夺走一切 整个计划中的发现
- 在审定规则方面没有损失,合并计划不会比原计划多或少验证
- 较易读取的根图结果a
- 删除几乎所有逻辑杂音
- 如果找不到逻辑相交点, 则抛出( 您的计画将无法从头验证任何东西 )
- 普通简单元验证器无法以某种方式验证
- 在合并包含这些内容的计划时,正确考虑额外的Propertys, typepertys和属性作为整体的一部分
- 在合并包含这些项目和额外项目的计划时,正确整体考虑这些项目和额外项目
- 支持将计划与项目合并为数组和直接计划
- 混合数组和计划时支持合并依赖性
- 支持所有 JSON schema 核心/验证关键字(v6, 使用自定义解析器支持其他关键字)
- 选择在使用时像添加属性那样覆盖常见不可能 额外收益:虚假
- 可插入关键字解析器
怎么样
由于AllOF要求提供的所有计划(包括母计划)都适用,我们可以在所有计划上依次排列,提取所有值,例如, 类型,并找到 相交点 有效数值。 以下是一个例子:
{
type: ['object', 'null'],
additionalProperties: {
type: 'string',
minLength: 5
},
allOf: [{
type: ['array', 'object'],
additionalProperties: {
type: 'string',
minLength: 10,
maxLength: 20
}
}]
}
因此
{
type: 'object',
additionalProperties: {
type: 'string',
minLength: 10,
maxLength: 20
}
}
注意该类型现在排除了无效和数组,因为从逻辑上讲这是不可能的。 另外minLength被提升到10. 其他的地产没有冲突,被合并入根子计划而不需要解决.
对于其他关键词,则使用其他方法,例如:
- 最小、最小、最小项目等选择 最高额 值.
- 最大线程、最大线程、最大线程等 最低 值.
- 如果 任意 相互冲突的价值观是真实的
上面的策略是选择 多数 限制冲突价值。 对于通过相交方式完成的一些关键词,对于其他关键词如 所需经费 它由一个所有价值观的联盟来完成,因为这是最具限制性的.
你所剩无几的 是一个完全没有一切的阴谋。 除了一些无法适当相交/相交的值:
没有
当多个冲突 没有 发现值时,我们也会使用模式使用的方法,而不是全部使用任何模式。 如果从任何OF中提取出共同规则,可以进一步简化.
选项
忽略附加财产 默认 虚假
允许您结合 计划属性,尽管一些计划有 additionalProperties: false 这是人们在试图利用AllOF扩展计划时面临的最常见问题,也是json schema spec的限制. 注意,尽管生产出来的计划 将允许更多 比原来的计划。 但是,如果仅仅想把计划结合起来,使用AllOF,就如同在合并过程中附加的Properties不是假的一样,这是有用的. 由此产生的计划仍然会让额外的Propertys被设定为虚假.
解析器 对象 覆盖任何这样的默认解析器 :
mergeAllOf(schema, {
resolvers: {
title: function(values, path, mergeSchemas, options) {
// choose what title you want to be used based on the conflicting values
// resolvers MUST return a value other than undefined
}
}
})
深处 布尔, 默认值 真实
如果错误, 只解决顶层 allOf 计划的关键词.
如果是真的,就解决一切 allOf 计划的关键词.
函数通过 :
- 数值 需要解决的一系列相冲突价值观
- 路径 一系列字符串,其中包含导致调用解析器的图中位置的路径(如果对多个关键字使用相同的解析器,或想要执行自定义路径的具体逻辑)
- 合并计划 可以调用合并一系列计划功能
- 选项 选项合并
联合解决者
不要求单独的解析器用于图案Properties和附加Properties,只要求属性解析器. 附加项目相同,只调用项目解析器。 这是因为这些关键词相互影响时需要一起解决.
这两个解析器预计将返回一个包含所有相关关键字解析值的对象。 密钥必须是关键词的名称. 因此属性解析器需要返回这样的对象,其中包含每个关键字的解析值:
{
properties: ...,
patternProperties: ...,
additionalProperties: ...,
}
解析功能也没有传递 合并计划对象 合并 包含每个相关关键字的合并。 因此属性通过这样的对象:
var mergers = {
properties: function mergeSchemas(schemas, childSchemaName){...},
patternProperties: function mergeSchemas(schemas, childSchemaName){...},
additionalProperties: function mergeSchemas(schemas){...},
}
有些合并要求您提供您当前正在合并的子schema 的名称或索引的字符串 。 这是为了确保传递给儿童解决者的路径是正确的.
默认解析器
您可以设置一个默认解析器, 以获取任何未知关键字 。 假设您想要使用与元关键词相同的策略,使用找到的第一个值. 你可以做到这样:
mergeJsonSchema({
...
}, {
resolvers: {
defaultResolver: mergeJsonSchema.options.resolvers.title
}
})
解析器
每当在图中同一位置上发现多个相冲突值时,就会调用解析器.
您可以通过在选项中提供解析器来覆盖解析器 .
损失与无损失
所有为验证关键字而以减码器构建的都是无损失的,意味着它们在验证方面不删除或添加任何内容.
对于标题,描述, $id, $schema等元关键词, 默认策略是如果存在相冲突的值, 使用第一个可能值 。 所以根子计划是优先的。 这一过程可能会从您的计划中删除一些元信息 。 故为失也. 通过提供自定义解析器来取代它 .
(单位:美元)
如果你的某个计划包含一个 $ref 财产,你应该解决它们 使用一个裁判解析器像 json-schema-ref-parser (英语) 先为您参考你的计划 解决$refs不是这个库的任务.
其他图书馆
有一些图书馆声称要将计划与AllOF合并,但它们只是将计划与A 非常喜欢 基本逻辑。 基本上跟罗达什的合并一样 所以,你冒着被一个 允许更多或更少 比原来的计划允许.
限制
我们不能把逻辑上不可能的计划合并起来,比如:
{
type: 'object',
allOf: [{
type: 'array'
}]
}
然后库会丢出一个错误, 报告没有有效相交点的值 。 但再说一次,你的原计划 也不会验证任何东西.
路线图
- 将相互依存的验证,如属性和额外收益视为一个解析器(和项目附加项目)
- 从任何 Of/ oneOf 中提取重复验证符并将其与父方案合并
- 在从任何 Off/ One 提取验证器后, 进行对比并去除重复 .
- 如果只留下一个在任何 Of/ Of 中, 那么将其合并到父计划 .
- 用于验证、提取的 Exposse 聚合工具
- 考虑添加更符合逻辑的验证( 如 minLength 最大Length)
捐款
创建新功能测试并遵循 Eslint 规则.
许可证
麻省理工学院 马丁·汉森