ajv

Validator skema Ajv JSON

Validator JSON tercepat untuk Node.js dan browser.

Mendukung draft Skema JSON-04/06/07/2019-09/2020-12 (dukungan draft-04 memerlukan paket ajv-draft-04) dan Definisi Tipe JSON RFC8927.

Sponsor Ajv

Berkontribusi

Lebih dari 100 orang berkontribusi pada Ajv, dan kami ingin Anda bergabung dalam pengembangan ini. Kami menyambut baik penerapan fitur-fitur baru yang akan bermanfaat bagi banyak pengguna dan ide-ide untuk meningkatkan dokumentasi kami.

Harap tinjau pedoman Berkontribusi dan komponen Kode.

Dokumentasi

Semua dokumentasi tersedia di situs web Ajv.

Beberapa tautan situs yang berguna:

• Memulai
• Skema JSON vs Definisi Tipe JSON
• Referensi API
• Modus yang ketat
• Kode validasi mandiri
• Pertimbangan keamanan
• Antarmuka baris perintah
• Pertanyaan yang Sering Diajukan

Silakan mensponsori pengembangan Ajv

Sejak saya meminta untuk mendukung pengembangan Ajv, 40 orang dan 6 organisasi berkontribusi melalui GitHub dan OpenCollective - dukungan ini membantu menerima hibah MOSS!

Dukungan Anda yang berkelanjutan sangatlah penting - dana akan digunakan untuk mengembangkan dan memelihara Ajv setelah versi mayor berikutnya dirilis.

Silakan sponsori Ajv melalui:

• Halaman sponsor GitHub (GitHub akan mencocokkannya)
• Kolektif Terbuka Ajv

Terima kasih.

Buka sponsor Kolektif

Pertunjukan

Ajv menghasilkan kode untuk mengubah Skema JSON menjadi fungsi validasi super cepat yang efisien untuk pengoptimalan v8.

Saat ini Ajv adalah validator tercepat dan paling memenuhi standar menurut tolok ukur berikut:

• json-schema-benchmark - 50% lebih cepat dari tempat kedua
• patokan jsck - 20-190% lebih cepat
• tolok ukur skema-z
• patokan mereka

Kinerja validator yang berbeda berdasarkan json-schema-benchmark:

Fitur

• Ajv mengimplementasikan standar JSON Schema draft-06/07/2019-09/2020-12 (draft-04 didukung di v6):
  • semua kata kunci validasi (lihat kata kunci validasi Skema JSON)
  • Ekstensi OpenAPI:
    • BARU: diskriminator kata kunci.
    • kata kunci dapat dibatalkan.
  • dukungan penuh untuk referensi jarak jauh (skema jarak jauh harus ditambahkan dengan addSchema atau dikompilasi agar tersedia)
  • dukungan referensi rekursif antar skema
  • panjang string yang benar untuk string dengan pasangan unicode
  • Format Skema JSON (dengan plugin ajv-formats).
  • memvalidasi skema terhadap meta-skema
• BARU: mendukung Definisi Tipe JSON:
  • semua kata kunci (lihat formulir skema Definisi Tipe JSON)
  • meta-skema untuk skema JTD
  • Kata kunci "union" dan kata kunci yang ditentukan pengguna (dapat digunakan di dalam anggota skema "metadata")
• mendukung browser dan Node.js 10.x - terkini
• pemuatan skema referensi yang tidak sinkron selama kompilasi
• Mode validasi "Semua kesalahan" dengan opsi allErrors
• pesan kesalahan dengan parameter yang menjelaskan alasan kesalahan untuk memungkinkan pembuatan pesan kesalahan
• dukungan pesan kesalahan i18n dengan paket ajv-i18n
• menghapus-properti-tambahan
• menetapkan default ke properti dan item yang hilang
• memaksa data ke tipe yang ditentukan dalam kata kunci type
• kata kunci yang ditentukan pengguna
• kata kunci ekstensi tambahan dengan paket kata kunci ajv
• Referensi $data untuk menggunakan nilai dari data yang divalidasi sebagai nilai untuk kata kunci skema
• validasi asinkron dari format dan kata kunci yang ditentukan pengguna

Memasang

Untuk menginstal versi 8:

 npm install ajv

Memulai

Cobalah di REPL Node.js: https://runkit.com/npm/ajv

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

Pelajari cara menggunakan Ajv dan lihat contoh lainnya di Panduan: memulai

Mengubah sejarah

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

Harap diperhatikan : Perubahan pada versi 8.0.0

Versi 7.0.0

Versi 6.0.0.

Kode etik

Harap meninjau dan mengikuti Kode Etik.

Silakan laporkan segala perilaku yang tidak dapat diterima ke [email protected] - perilaku tersebut akan ditinjau oleh tim proyek.

Kontak keamanan

Untuk melaporkan kerentanan keamanan, silakan gunakan kontak keamanan Tidelift. Tidelift akan mengoordinasikan perbaikan dan pengungkapan. Harap JANGAN melaporkan kerentanan keamanan melalui masalah GitHub.

Dukungan perangkat lunak sumber terbuka

Ajv adalah bagian dari langganan Tidelift - ini memberikan dukungan terpusat kepada pengguna perangkat lunak sumber terbuka, selain dukungan yang diberikan oleh pengelola perangkat lunak.

Lisensi

MIT