semix-validate v0.1.10

semix-validate

基于 JSONSchema 的校验器

规则定义语法

{
  // 错误信息
  message: '',
  // error | warning
  level: '',
  // 错误细节
  detail: '',
  // 校验场景
  scene: '',
  // 校验器
  schema: {
    '选择器1': (value, ctx) => {
      // 校验方法
    },
    '选择器2': {
      // JSON Schema Validator 校验
      pattern: "^[a-zA-Z0-9]+$",
    },
    '选择器2': {
      // 自定义 JSON Schema Validator 关键字校验
      myCustomKeyword: true,
    }
  },
}

ctx 定义

ctx 定义请参见 ValidatorContext

选择器语法

可以把被校验的元数据的 Schema 当成 DOM，选择器当成 HTML DOM Selector。

例如被校验的是 OAS2.0 规范的 API，那么选择器则为被校验数据，在 Spec 定义中的路径。

// 校验 schema
definitions.schema
// 校验 map 的 schema
definitions.schema.properties.additionalProperties
// 校验 body 参数的描述
definitions.bodyParameter.properties.description
// 校验基本路径
properties.basePath