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

JSON-схема (JSON Schema) — это лексический стандарт на основе JSON для описания структуры и ограничений данных в формате JSON. Позволяет валидировать, описывать и документировать JSON-данные.

Основные цели:

• Валидация: Проверка соответствия экземпляра JSON определенной структуре.
• Документация: Описание формата JSON-данных.
• Взаимодействие: Обмен метаданными между системами.

Ключевые компоненты JSON-схемы:

• Типы данных: string, number, integer, boolean, object, array, null.
• Ключевые слова для ограничений:
  • type: Ожидаемый тип данных.
  • properties: Описание свойств объекта. Каждое свойство имеет свою под-схему.
  • required: Список обязательных свойств для объекта.
  • items: Описание элементов массива.
  • minLength/maxLength: Ограничения длины для строк.
  • minimum/maximum: Ограничения для чисел.
  • pattern: Регулярное выражение для строки.
  • enum: Список допустимых значений.
  • allOf/anyOf/oneOf/not: Логические комбинации схем.
• Ключевые слова для метаданных:
  • title: Краткое название схемы.
  • description: Подробное описание схемы.
  • default: Значение по умолчанию.

Пример JSON-схемы:

{
  "type": "object",
  "properties": {
    "id": {
      "type": "integer",
      "description": "Уникальный идентификатор пользователя"
    },
    "username": {
      "type": "string",
      "minLength": 3
    },
    "isActive": {
      "type": "boolean",
      "default": true
    }
  },
  "required": [
    "id",
    "username"
  ]
}

Пример JSON-данных, валидных по этой схеме:

{
  "id": 123,
  "username": "testuser",
  "isActive": false
}

Пример JSON-данных, невалидных по этой схеме:

{
  "id": "abc" // Неверный тип
  // Отсутствует обязательное поле "username"
}

Использование JSON-схемы в QA Automation:

• Валидация ответов API: Проверка, соответствуют ли JSON-ответы заданному формату.
• Валидация запросов: Проверка входящих JSON-данных перед их обработкой.
• Генерация тестовых данных: Использование схемы для создания валидных (или невалидных) тестовых примеров.
• Документация: Создание автоматически поддерживаемой документации по API.

Существуют библиотеки для работы с JSON-схемами на различных языках программирования (например, jsonschema для Python, json-schema-validator для Java).