ajv README

The project's README from github.com/ajv-validator/ajv. As one markdown file: README.md.

Ajv logo

 

Ajv JSON schema validator

The fastest JSON validator for Node.js and browser.

Supports JSON Schema draft-04/06/07/2019-09/2020-12 (draft-04 support requires ajv-draft-04 package) and JSON Type Definition RFC8927.

build npm npm downloads Coverage Status SimpleX Gitter GitHub Sponsors

Ajv sponsors

Mozilla

Microsoft

RetoolTideliftSimpleX

Contributing

More than 100 people contributed to Ajv, and we would love to have you join the development. We welcome implementing new features that will benefit many users and ideas to improve our documentation.

Please review Contributing guidelines and Code components.

Documentation

All documentation is available on the Ajv website.

Some useful site links:

Please sponsor Ajv development

Since I asked to support Ajv development 40 people and 6 organizations contributed via GitHub and OpenCollective - this support helped receiving the MOSS grant!

Your continuing support is very important - the funds will be used to develop and maintain Ajv once the next major version is released.

Please sponsor Ajv via:

Thank you.

Open Collective sponsors

Performance

Ajv generates code to turn JSON Schemas into super-fast validation functions that are efficient for v8 optimization.

Currently Ajv is the fastest and the most standard compliant validator according to these benchmarks:

Performance of different validators by json-schema-benchmark:

performance

Features

Install

To install version 8:

npm install ajv

Getting started

Try it in the Node.js REPL: 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)

Learn how to use Ajv and see more examples in the Guide: getting started

Changes history

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

Please note: Changes in version 8.0.0

Version 7.0.0

Version 6.0.0.

Code of conduct

Please review and follow the Code of conduct.

Please report any unacceptable behaviour to [email protected] - it will be reviewed by the project team.

Security contact

To report a security vulnerability, please use the Tidelift security contact. Tidelift will coordinate the fix and disclosure. Please do NOT report security vulnerabilities via GitHub issues.

Open-source software support

Ajv is a part of Tidelift subscription - it provides a centralised support to open-source software users, in addition to the support provided by software maintainers.

License

MIT

ajv (ajv-validator/ajv)

Searching Database…

14.9K ·GitHub
Ajv
Что это такое?Ajv — это валидатор JSON-схем для JavaScript: вы даёте ему схему, а он проверяет, что ваши JSON-данные ей соответствуют. Он позиционируется как самый быстрый и поддерживает JSON Schema от draft-04 до 2020-12, а также JSON Type Definition (RFC 8927).
Так это библиотека, которую я подключаю в свой код, или отдельное приложение?Это библиотека, а не приложение: вы встраиваете её в свой код на JavaScript или TypeScript. В документации также описаны интерфейс командной строки и генерация автономного кода валидации.
Как начать пользоваться этим в своём проекте?Установите пакет из npm и вызывайте его из своего JavaScript-кода. В README предлагается попробовать его прямо в REPL Node.js, а раздел Getting started на сайте Ajv проведёт вас по остальным шагам.
Нужно ли что-то ещё, кроме установленных Node.js и npm?Нет: это чистый TypeScript всего с четырьмя небольшими JS-зависимостями (fast-deep-equal, fast-uri, json-schema-traverse, require-from-string), так что никакой нативной сборки или дополнительных инструментов устанавливать не нужно.
Обновление на новую мажорную версию пройдёт безболезненно?Стоит заложить время на миграцию: в changelog отмечены значимые изменения для каждого мажорного релиза, поэтому перед обновлением посмотрите примечания к версиям 8.0.0, 7.0.0 и 6.0.0.
Можно ли бесплатно использовать его в коммерческих проектах?Да: Ajv распространяется по лицензии MIT, так что коммерческое использование разрешено, а компаниям, которым нужна поддерживаемая версия, её могут предоставить по подписке Tidelift.
Что такое JSON Type Definition и почему Ajv его поддерживает?Это более простой альтернативный язык описания схем, стандартизованный как RFC 8927. Ajv валидирует данные по нему наряду с JSON Schema, а на сайте документации есть страница со сравнением этих двух подходов, чтобы вам было проще выбрать.
Можно ли на работе получить коммерческую поддержку Ajv?Да. Ajv входит в подписку Tidelift, которая даёт компаниям централизованную поддержку — в дополнение к той, что обеспечивают сами мейнтейнеры библиотеки.
Ajv ещё активно развивается?Да. Автор собирает средства на разработку и поддержку следующей мажорной версии, и работу уже проспонсировали 40 человек и 6 организаций через GitHub и OpenCollective; это также помогло получить грант MOSS.
What are similar projects?react-jsonschema-form, formily, sqlmodel, protobuf.js, os-taxonomy, multicoin-address-validator, class-validator, graphql-js
Which topics is it in?validator, json-schema, schema, validation, json, utility, performance, free, npm, tool, nodejs, library
Creator
ajv-validator
Size
38.1 MB
Stars
14.9K
Updated
CommitApr 24Releasev8.20.0Apr 24
Age
11y
Commits · 90 Days