Введение

JSON (JavaScript Object Notation) — это упрощенный формат обмена данными, который легко читать и писать для людей, а также легко анализировать и генерировать для машин. Однако обеспечение достоверности данных в объекте JSON и их соответствия определенным критериям может быть проблемой. Вот где JSON Schema приходит на помощь. JSON Schema — это мощный инструмент для проверки структуры и типов данных JSON. В этом сообщении блога мы рассмотрим, как использовать схему JSON для проверки ваших данных JSON, и предоставим примеры кода, которые помогут вам начать работу.

Что такое схема JSON?

Схема JSON — это словарь, который позволяет аннотировать и проверять документы JSON. Он предоставляет понятный, удобочитаемый и машиночитаемый язык схемы для описания ожидаемой структуры, типов данных и ограничений для данных JSON. Используя схему JSON, вы можете гарантировать, что ваши данные JSON непротиворечивы, соответствуют определенным правилам и с ними проще работать в разных приложениях и службах.

Начало работы со схемой JSON

Чтобы начать использовать схему JSON, вам необходимо иметь схему JSON и экземпляр JSON (данные, которые вы хотите проверить). Схема JSON — это объект JSON, который определяет правила для ваших данных. Вот простой пример схемы JSON для пользовательского объекта:

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "type": "object",
  "properties": {
    "name": {
      "type": "string"
    },
    "age": {
      "type": "integer",
      "minimum": 18
    },
    "email": {
      "type": "string",
      "format": "email"
    }
  },
  "required": ["name", "email"]
}

Эта схема определяет объект пользователя с тремя свойствами: имя, возраст и адрес электронной почты. Свойства имени и электронной почты являются обязательными, а свойство возраста является необязательным. Свойство электронной почты должно быть действительным адресом электронной почты, а возраст должен быть целым числом, большим или равным 18.

Проверка данных JSON с помощью схемы JSON

Существует множество библиотек для проверки данных JSON по схеме JSON. В этом примере мы будем использовать популярную библиотеку «ajv» в JavaScript. Во-первых, вам нужно установить пакет «ajv» с помощью npm:

npm install ajv

Затем создайте файл JavaScript (например, validate.js) и импортируйте библиотеку ajv:

const Ajv = require('ajv');
const ajv = new Ajv();

// Your JSON schema and data go here

const isValid = ajv.validate(schema, data);
if (!isValid) {
  console.error(ajv.errorsText());
} else {
  console.log('JSON data is valid');
}

Замените // Your JSON schema and data go here своей схемой JSON и данными JSON, которые вы хотите проверить:

const schema = {
  // Your JSON schema
};

const data = {
  // Your JSON data
};

Теперь запустите свой скрипт с помощью Node.js:

node validate.js

Если ваши данные JSON действительны, вы должны увидеть «Данные JSON действительны» в консоли. Если нет, вы увидите сообщение об ошибке, описывающее проблемы проверки.

Заключение

Схема JSON — это мощный инструмент для обеспечения согласованности и достоверности ваших данных JSON. Используя схему JSON для определения структуры и ограничений ваших данных, вы можете сэкономить время и предотвратить ошибки, выявляя проблемы на ранних этапах процесса разработки. Благодаря широкому спектру доступных библиотек можно легко интегрировать проверку схемы JSON в существующие проекты и рабочие процессы.

  1. Официальная документация по схеме JSON
  2. Руководство по проверке схемы JSON в веб-документах MDN
  3. Онлайн-валидатор JSON Schema Lint

Понравилось читать? Еще не являетесь участником Medium? Вы можете поддержать мою работу напрямую, зарегистрировавшись по моей реферальной ссылке здесь. Это быстро, просто и не требует дополнительных затрат. Спасибо за вашу поддержку!