@ apideck/ better-ajv-errors - #############################################################################################################################################################################################################################################

JSON Schema APIs 对人类友好的验证

• 可读和有帮助 页:1 错误
• API 方便格式
• 关于拼写错误的建议
• 最小足迹: 1.56 kB(gzip + minized)

安装

$ yarn add @apideck/better-ajv-errors

或者说

$ npm i @apideck/better-ajv-errors

还要确保你安装好了 页:1 在版本8或更高.

使用量

用 ajv 验证一些数据后, 将错误传递到 betterAjvErrors

import Ajv from 'ajv';
import { betterAjvErrors } from '@apideck/better-ajv-errors';

// Without allErrors: true, ajv will only return the first error
const ajv = new Ajv({ allErrors: true });

const valid = ajv.validate(schema, data);

if (!valid) {
  const betterErrors = betterAjvErrors({ schema, data, errors: ajv.errors });
}

API 密码

更好的错误

将 ajv 校验错误格式化为方便人格式的函数 .

参数

• options: BetterAjvErrorsOptions
  • errors: ErrorObject[] | null | undefined 你的jv错误,你会发现这些在 errors 您的 ajv 实例的财产( ưμ㼯a)ErrorObject 是 ajv 包中的一种类型.
  • data: Object 你传给Ajv的数据需要验证.
  • schema: JSONSchema 你传到Ajv的计谋来验证对手.
  • basePath?: string 返回前缀路径的可选基础路径 betterAjvErrors。例如,在APIs中,使用 '{requestBody}' 或者说 '{queryParemeters}' 作为基础Path。 这将向用户说明错误的确切发生地点.

返回值

• ValidationError[] 格式化出错的组合( ValidationError (见下文)
  • message: string 格式化错误消息
  • suggestion?: string 根据所提供的数据和计划提出的任择建议
  • path: string 发生错误的对象路径( 例如 : .foo.bar.0.quz(中文(简体) )
  • context: { errorType: DefinedError['keyword']; [additionalContext: string]: unknown } errorType 实值 error.keyword 从 ajv。 。 。 . errorType 必要时可用作i18n的密钥. 根据出错的类型,可能存在额外的上下文属性.

相关

• 地图册/更好的 -- -- jev -- -- 误差 是这个图书馆的灵感 Atlassian的库更注重CLI出错,这个库注重开发者方便的API出错消息.