ajv

Validateur de schéma Ajv JSON

Le validateur JSON le plus rapide pour Node.js et le navigateur.

Prend en charge le schéma JSON draft-04/06/07/2019-09/2020-12 (la prise en charge du draft-04 nécessite le package ajv-draft-04) et la définition de type JSON RFC8927.

Commanditaires de l'AJV

Contribuer

Plus de 100 personnes ont contribué à Ajv et nous serions ravis que vous rejoigniez le développement. Nous sommes favorables à la mise en œuvre de nouvelles fonctionnalités qui bénéficieront à de nombreux utilisateurs et aux idées pour améliorer notre documentation.

Veuillez consulter les directives de contribution et les composants du code.

Documentation

Toute la documentation est disponible sur le site de l'Ajv.

Quelques liens de sites utiles :

• Commencer
• Schéma JSON et définition de type JSON
• Référence API
• Mode strict
• Code de validation autonome
• Considérations de sécurité
• Interface de ligne de commande
• Foire aux questions

Veuillez parrainer le développement d'Ajv

Depuis que j'ai demandé à soutenir le développement d'Ajv, 40 personnes et 6 organisations ont contribué via GitHub et OpenCollective - ce soutien m'a permis de recevoir la subvention MOSS !

Votre soutien continu est très important - les fonds seront utilisés pour développer et maintenir Ajv une fois la prochaine version majeure publiée.

Veuillez parrainer Ajv via :

• Page des sponsors GitHub (GitHub y correspondra)
• Ajv Collectif Ouvert

Merci.

Parrains du Collectif Ouvert

Performance

Ajv génère du code pour transformer les schémas JSON en fonctions de validation ultra-rapides et efficaces pour l'optimisation v8.

Actuellement, Ajv est le validateur le plus rapide et le plus conforme aux normes selon ces critères :

• json-schema-benchmark - 50 % plus rapide que la deuxième place
• benchmark jsck - 20 à 190 % plus rapide
• référence du schéma z
• référence thématique

Performances des différents validateurs par json-schema-benchmark :

Caractéristiques

• Ajv implémente les normes JSON Schema draft-06/07/2019-09/2020-12 (le draft-04 est pris en charge dans la v6) :
  • tous les mots-clés de validation (voir Mots-clés de validation du schéma JSON)
  • Extensions OpenAPI :
    • NOUVEAU : discriminateur de mots clés.
    • mot-clé nullable.
  • prise en charge complète des références distantes (les schémas distants doivent être ajoutés avec addSchema ou compilés pour être disponibles)
  • prise en charge des références récursives entre les schémas
  • longueurs de chaîne correctes pour les chaînes avec des paires Unicode
  • Formats de schéma JSON (avec plugin ajv-formats).
  • valide les schémas par rapport au méta-schéma
• NOUVEAU : prend en charge la définition de type JSON :
  • tous les mots-clés (voir les formulaires de schéma de définition de type JSON)
  • méta-schéma pour les schémas JTD
  • Mot-clé "union" et mots-clés définis par l'utilisateur (peuvent être utilisés dans le membre "métadonnées" du schéma)
• prend en charge les navigateurs et Node.js 10.x - actuel
• chargement asynchrone des schémas référencés lors de la compilation
• Mode de validation "Toutes les erreurs" avec option allErrors
• messages d'erreur avec des paramètres décrivant les raisons de l'erreur pour permettre la génération de messages d'erreur
• Prise en charge des messages d'erreur i18n avec le package ajv-i18n
• suppression-de-propriétés-supplémentaires
• attribuer des valeurs par défaut aux propriétés et éléments manquants
• forcer les données aux types spécifiés dans les mots-clés type
• mots-clés définis par l'utilisateur
• mots-clés d'extension supplémentaires avec le package ajv-keywords
• Référence $data pour utiliser les valeurs des données validées comme valeurs pour les mots-clés du schéma
• validation asynchrone des formats et mots-clés définis par l'utilisateur

Installer

Pour installer la version 8 :

 npm install ajv

Commencer

Essayez-le dans le REPL Node.js : 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 )

Apprenez à utiliser Ajv et voyez plus d'exemples dans le Guide : pour commencer

Historique des modifications

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

Attention : Modifications dans la version 8.0.0

Version 7.0.0

Version 6.0.0.

Code de conduite

Veuillez lire et suivre le code de conduite.

Veuillez signaler tout comportement inacceptable à [email protected] - il sera examiné par l'équipe du projet.

Contact de sécurité

Pour signaler une vulnérabilité de sécurité, veuillez utiliser le contact de sécurité Tidelift. Tidelift coordonnera le correctif et la divulgation. Veuillez NE PAS signaler les vulnérabilités de sécurité via les problèmes GitHub.

Prise en charge des logiciels open source

Ajv fait partie de l'abonnement Tidelift - il fournit un support centralisé aux utilisateurs de logiciels open source, en plus du support fourni par les mainteneurs de logiciels.

Licence

MIT