ajv

Validador de esquema Ajv JSON

El validador JSON más rápido para Node.js y navegador.

Admite el esquema JSON draft-04/06/07/2019-09/2020-12 (la compatibilidad con el borrador-04 requiere el paquete ajv-draft-04) y la definición de tipo JSON RFC8927.

Patrocinadores

Contribuyendo

Más de 100 personas contribuyeron a Ajv y nos encantaría que te unieras al desarrollo. Damos la bienvenida a la implementación de nuevas funciones que beneficiarán a muchos usuarios e ideas para mejorar nuestra documentación.

Revise las pautas de contribución y los componentes del código.

Documentación

Toda la documentación está disponible en la web de Ajv.

Algunos enlaces de sitios útiles:

• Empezando
• Esquema JSON frente a definición de tipo JSON
• Referencia API
• modo estricto
• Código de validación independiente
• Consideraciones de seguridad
• Interfaz de línea de comando
• Preguntas frecuentes

Por favor patrocine el desarrollo de Ajv

Desde que solicité apoyar el desarrollo de Ajv, 40 personas y 6 organizaciones contribuyeron a través de GitHub y OpenCollective. ¡Este apoyo ayudó a recibir la subvención MOSS!

Su continuo apoyo es muy importante: los fondos se utilizarán para desarrollar y mantener Ajv una vez que se lance la próxima versión principal.

Por favor patrocine a Ajv a través de:

• Página de patrocinadores de GitHub (GitHub la igualará)
• Colectivo Abierto Ajv

Gracias.

Patrocinadores del Colectivo Abierto

Actuación

Ajv genera código para convertir esquemas JSON en funciones de validación súper rápidas que son eficientes para la optimización v8.

Actualmente, Ajv es el validador más rápido y que cumple con los estándares según estos puntos de referencia:

• json-schema-benchmark: 50% más rápido que el segundo lugar
• Punto de referencia jsck: 20-190% más rápido
• punto de referencia del esquema z
• punto de referencia themis

Rendimiento de diferentes validadores según json-schema-benchmark:

Características

• Ajv implementa los estándares JSON Schema draft-06/07/2019-09/2020-12 (el draft-04 es compatible con v6):
  • todas las palabras clave de validación (consulte Palabras clave de validación del esquema JSON)
  • Extensiones de OpenAPI:
    • NUEVO: discriminador de palabras clave.
    • palabra clave anulable.
  • soporte completo de referencias remotas (los esquemas remotos deben agregarse con addSchema o compilarse para que estén disponibles)
  • soporte de referencias recursivas entre esquemas
  • longitudes de cadena correctas para cadenas con pares Unicode
  • Formatos de esquema JSON (con complemento de formatos ajv).
  • valida esquemas contra metaesquema
• NUEVO: admite definición de tipo JSON:
  • todas las palabras clave (consulte los formularios de esquema de definición de tipo JSON)
  • metaesquema para esquemas JTD
  • Palabra clave "union" y palabras clave definidas por el usuario (se pueden usar dentro del miembro "metadatos" del esquema)
• admite navegadores y Node.js 10.x - actual
• carga asincrónica de esquemas referenciados durante la compilación
• Modo de validación "Todos los errores" con la opción allErrors
• mensajes de error con parámetros que describen las razones del error para permitir la generación de mensajes de error
• Soporte de mensajes de error de i18n con el paquete ajv-i18n
• eliminando-propiedades-adicionales
• asignar valores predeterminados a propiedades y elementos faltantes
• obligar a los datos a los tipos especificados en las palabras clave type
• palabras clave definidas por el usuario
• palabras clave de extensión adicionales con el paquete ajv-keywords
• Referencia de $data para usar valores de los datos validados como valores para las palabras clave del esquema
• Validación asincrónica de formatos y palabras clave definidos por el usuario.

Instalar

Para instalar la versión 8:

 npm install ajv

Empezando

Pruébelo en Node.js REPL: https://runkit.com/npm/ajv

En JavaScript:

 // or ESM/TypeScript import
import Ajv from "ajv"
// Node.js require:
const Ajv = require ( "ajv" )

const ajv = new Ajv ( ) // options can be passed, e.g. {allErrors: true}

const schema = {
  type : "object" ,
  properties : {
    foo : { type : "integer" } ,
    bar : { type : "string" } ,
  } ,
  required : [ "foo" ] ,
  additionalProperties : false ,
}

const data = {
  foo : 1 ,
  bar : "abc" ,
}

const validate = ajv . compile ( schema )
const valid = validate ( data )
if ( ! valid ) console . log ( validate . errors )

Aprenda a utilizar Ajv y vea más ejemplos en la Guía: cómo empezar

Historial de cambios

Ver https://github.com/ajv-validator/ajv/releases

Tenga en cuenta : Cambios en la versión 8.0.0

Versión 7.0.0

Versión 6.0.0.

Código de conducta

Revise y siga el Código de conducta.

Informe cualquier comportamiento inaceptable a [email protected]; será revisado por el equipo del proyecto.

Contacto de seguridad

Para informar una vulnerabilidad de seguridad, utilice el contacto de seguridad de Tidelift. Tidelift coordinará la solución y la divulgación. NO informe vulnerabilidades de seguridad a través de problemas de GitHub.

Soporte de software de código abierto

Ajv es parte de la suscripción a Tidelift: proporciona soporte centralizado a los usuarios de software de código abierto, además del soporte brindado por los mantenedores del software.

Licencia

MIT