ajv

Ajv JSON-Schema-Validator

Der schnellste JSON-Validator für Node.js und Browser.

Unterstützt das JSON-Schema Draft-04/06/07/2019-09/2020-12 (Unterstützung für Draft-04 erfordert das Paket ajv-draft-04) und die JSON-Typdefinition RFC8927.

Ajv-Sponsoren

Mitwirken

Mehr als 100 Menschen haben zu Ajv beigetragen, und wir würden uns freuen, wenn Sie sich an der Entwicklung beteiligen würden. Wir begrüßen die Implementierung neuer Funktionen, die vielen Benutzern zugute kommen, und Ideen zur Verbesserung unserer Dokumentation.

Bitte lesen Sie sich die Beitragsrichtlinien und Kodexkomponenten durch.

Dokumentation

Die gesamte Dokumentation ist auf der Ajv-Website verfügbar.

Einige nützliche Site-Links:

• Erste Schritte
• JSON-Schema vs. JSON-Typdefinition
• API-Referenz
• Strenger Modus
• Eigenständiger Validierungscode
• Sicherheitsüberlegungen
• Befehlszeilenschnittstelle
• Häufig gestellte Fragen

Bitte sponsern Sie die Ajv-Entwicklung

Seit ich darum gebeten habe, die Ajv-Entwicklung zu unterstützen, haben 40 Personen und 6 Organisationen über GitHub und OpenCollective beigetragen – diese Unterstützung hat dazu beigetragen, das MOSS-Stipendium zu erhalten!

Ihre kontinuierliche Unterstützung ist sehr wichtig – die Mittel werden für die Entwicklung und Wartung von Ajv verwendet, sobald die nächste Hauptversion veröffentlicht wird.

Bitte sponsern Sie Ajv über:

• GitHub-Sponsorenseite (GitHub passt dazu)
• Ajv Open Collective

Danke schön.

Offene Kollektivsponsoren

Leistung

Ajv generiert Code, um JSON-Schemas in superschnelle Validierungsfunktionen umzuwandeln, die für die v8-Optimierung effizient sind.

Derzeit ist Ajv gemäß diesen Benchmarks der schnellste und standardkonformste Validator:

• json-schema-benchmark – 50 % schneller als der Zweitplatzierte
• jsck-Benchmark – 20–190 % schneller
• Z-Schema-Benchmark
• themis-Benchmark

Leistung verschiedener Validatoren nach json-schema-benchmark:

Merkmale

• Ajv implementiert die JSON-Schema-Standards Draft-06/07/2019-09/2020-12 (Draft-04 wird in Version 6 unterstützt):
  • alle Validierungsschlüsselwörter (siehe JSON-Schema-Validierungsschlüsselwörter)
  • OpenAPI-Erweiterungen:
    • NEU: Schlüsselwort-Diskriminator.
    • Schlüsselwort nullbar.
  • volle Unterstützung von Remote-Referenzen (Remote-Schemas müssen mit addSchema hinzugefügt oder kompiliert werden, um verfügbar zu sein)
  • Unterstützung rekursiver Referenzen zwischen Schemata
  • Korrekte Stringlängen für Strings mit Unicode-Paaren
  • JSON-Schemaformate (mit Ajv-Formats-Plugin).
  • validiert Schemata anhand des Metaschemas
• NEU: unterstützt JSON-Typdefinition:
  • alle Schlüsselwörter (siehe JSON-Typdefinitionsschemaformulare)
  • Metaschema für JTD-Schemas
  • Schlüsselwort „union“ und benutzerdefinierte Schlüsselwörter (können innerhalb des Mitglieds „metadata“ des Schemas verwendet werden)
• Unterstützt Browser und Node.js 10.x – aktuell
• Asynchrones Laden referenzierter Schemata während der Kompilierung
• Validierungsmodus „Alle Fehler“ mit der Option allErrors
• Fehlermeldungen mit Parametern, die Fehlergründe beschreiben, um die Generierung von Fehlermeldungen zu ermöglichen
• Unterstützung von i18n-Fehlermeldungen mit dem Paket ajv-i18n
• Entfernen zusätzlicher Eigenschaften
• Zuweisen von Standardwerten zu fehlenden Eigenschaften und Elementen
• Umwandeln von Daten in die in type angegebenen Typen
• benutzerdefinierte Schlüsselwörter
• zusätzliche Erweiterungsschlüsselwörter mit dem Paket ajv-keywords
• $data-Referenz, um Werte aus den validierten Daten als Werte für die Schemaschlüsselwörter zu verwenden
• asynchrone Validierung benutzerdefinierter Formate und Schlüsselwörter

Installieren

So installieren Sie Version 8:

 npm install ajv

Erste Schritte

Probieren Sie es in der Node.js REPL aus: https://runkit.com/npm/ajv

In 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 )

Erfahren Sie, wie Sie Ajv verwenden und sehen Sie sich weitere Beispiele im Leitfaden „Erste Schritte“ an

Ändert den Verlauf

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

Bitte beachten Sie : Änderungen in Version 8.0.0

Version 7.0.0

Version 6.0.0.

Verhaltenskodex

Bitte lesen Sie sich den Verhaltenskodex durch und befolgen Sie ihn.

Bitte melden Sie inakzeptables Verhalten an [email protected] – es wird vom Projektteam überprüft.

Sicherheitskontakt

Um eine Sicherheitslücke zu melden, wenden Sie sich bitte an den Sicherheitskontakt von Tidelift. Tidelift wird die Behebung und Offenlegung koordinieren. Bitte melden Sie Sicherheitslücken NICHT über GitHub-Probleme.

Unterstützung für Open-Source-Software

Ajv ist Teil des Tidelift-Abonnements – es bietet zusätzlich zum Support durch Software-Betreuer einen zentralisierten Support für Open-Source-Software-Benutzer.

Lizenz

MIT