Human-friendly JSON Schema validation for APIs
bash
$ yarn add @apideck/better-ajv-errors
or
bash
$ npm i @apideck/better-ajv-errors
Also make sure that you’ve installed ajv at version 8 or higher.
After validating some data with ajv, pass the errors to betterAjvErrors
```ts 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 }); } ```
Function that formats ajv validation errors in a human-friendly format.
options: BetterAjvErrorsOptions
errors: ErrorObject[] | null | undefined Your ajv errors, you will find these in the errors property of your ajv instance (ErrorObject is a type from the ajv package).data: Object The data you passed to ajv to be validated.schema: JSONSchema The schema you passed to ajv to validate against.basePath?: string An optional base path to prefix paths returned by betterAjvErrors. For example, in APIs, it could be useful to use '{requestBody}' or '{queryParemeters}' as a basePath. This will make it clear to users where exactly the error occurred.ValidationError[] Array of formatted errors (properties of ValidationError below)
message: string Formatted error messagesuggestion?: string Optional suggestion based on provided data and schemapath: string Object path where the error occurred (example: .foo.bar.0.quz)context: { errorType: DefinedError['keyword']; [additionalContext: string]: unknown } errorType is error.keyword proxied from ajv. errorType can be used as a key for i18n if needed. There might be additional properties on context, based on the type of error.