使用 ajv json 模式验证器的用户友好错误消息

Question

假设我有架构和 JSON：

JSON 架构：

const schema = {
  "$schema": "http://json-schema.org/draft-07/schema#",
  "type": "object",
  "required": [ "countries" ],
  "definitions": {
    "europeDef": {
      "type": "object",
      "required": ["type"],
      "properties": { "type": {"const": "europe"} }
    },
    "asiaDef": {
      "type": "object",
      "required": ["type"],
      "properties": { "type": {"const": "asia"} }
    }
  },
  "properties": {
    "countries": {
      "type": "array",
      "items": {
        "oneOf":[
          { "$ref": "#/definitions/europeDef" },
          { "$ref": "#/definitions/asiaDef"}
        ]
      }
    }
  }
}

JSON：

const data = {
  "countries":[
    {"type": "asia1"},
    {"type": "europe1"}
  ]
}

const isValid = ajv.validate(schema, data); //schema, data
if(! isValid){
  console.log(ajv.errors);
}

以及错误信息：

[ { keyword: 'const',
    dataPath: '/countries/0/type',
    schemaPath: '#/definitions/europeDef/properties/type/const',
    params: { allowedValue: 'europe' },
    message: 'should be equal to constant' },
  { keyword: 'const',
    dataPath: '/countries/0/type',
    schemaPath: '#/definitions/asiaDef/properties/type/const',
    params: { allowedValue: 'asia' },
    message: 'should be equal to constant' },
  { keyword: 'oneOf',
    dataPath: '/countries/0',
    schemaPath: '#/properties/countries/items/oneOf',
    params: { passingSchemas: null },
    message: 'should match exactly one schema in oneOf' },
  { keyword: 'const',
    dataPath: '/countries/1/type',
    schemaPath: '#/definitions/europeDef/properties/type/const',
    params: { allowedValue: 'europe' },
    message: 'should be equal to constant' },
  { keyword: 'const',
    dataPath: '/countries/1/type',
    schemaPath: '#/definitions/asiaDef/properties/type/const',
    params: { allowedValue: 'asia' },
    message: 'should be equal to constant' },
  { keyword: 'oneOf',
    dataPath: '/countries/1',
    schemaPath: '#/properties/countries/items/oneOf',
    params: { passingSchemas: null },
    message: 'should match exactly one schema in oneOf' } ]

我的问题是，因为我已经导出了这个模式，所以我几乎可以理解这个错误。但是对于第三者来说，肯定需要一些时间才能弄清楚（如果架构/错误更复杂，可能需要更多时间）。

有什么方法可以让它更加用户友好？

Answer 1

您可以使用 ajv-errors 扩展自定义消息，让您编写更好的消息（或应用 I18N 逻辑的键）。

它会显示你在errorMessage中设置的内容

const Ajv = require('ajv')
const AjvErrors = require('ajv-errors')

const ajv = new Ajv({ allErrors: true, jsonPointers: true })
AjvErrors(ajv)

const isValid = ajv.validate(yourSchema(), {
  countries: [
    { type: 'asia1' },
    { type: 'europe1' }
  ]
})
console.log(isValid)

if (!isValid) {
  console.log(ajv.errors)
}
function yourSchema () {
  return {
    $schema: 'http://json-schema.org/draft-07/schema#',
    type: 'object',
    required: ['countries'],
    definitions: {
      europeDef: {
        type: 'object',
        required: ['type'],
        properties: { type: { const: 'europe' } },
        errorMessage: 'it must be europe'
      },
      asiaDef: {
        type: 'object',
        required: ['type'],
        properties: { type: { const: 'asia' } },
        errorMessage: 'it must be asia'
      }
    },
    properties: {
      countries: {
        type: 'array',
        errorMessage: 'should be one of asia or europe',
        items: {
          oneOf: [
            { $ref: '#/definitions/europeDef' },
            { $ref: '#/definitions/asiaDef' }
          ]
        }
      }
    }
  }
}