← Назад к блогу

LLM для аналитика · 5 минут

XSD в JSON с проверкой: сначала договор о преобразовании, затем валидатор

XSD описывает XML, поэтому напрямую проверить JSON по XSD нельзя.

XSD описывает XML, поэтому напрямую проверить JSON по XSD нельзя. Для преобразования нужно определить соответствие элементов и JSON-полей, перенести ограничения в подходящую JSON Schema и проверить обе стороны. Если просто попросить LLM «сделать JSON», она может сохранить названия, но потерять обязательность, типы или различие между отсутствующим значением и null.

Учебный заказ содержит три элемента: id, quantity и необязательный comment. По нему проследим обязательность, тип числа и пустое значение. Атрибуты, choice, смешанное содержимое и прикладные пространства имён потребуют отдельного договора преобразования.

Исходная XSD

<xs:schema xmlns:xs="http://www.w3.org/2001/XMLSchema">
  <xs:element name="order">
    <xs:complexType>
      <xs:sequence>
        <xs:element name="id">
          <xs:simpleType>
            <xs:restriction base="xs:string">
              <xs:pattern value="O[0-9]{3}"/>
              <xs:length value="4"/>
            </xs:restriction>
          </xs:simpleType>
        </xs:element>
        <xs:element name="quantity" type="xs:positiveInteger"/>
        <xs:element name="comment" type="xs:string" minOccurs="0"/>
      </xs:sequence>
    </xs:complexType>
  </xs:element>
</xs:schema>

Пример XML: <order><id>O007</id><quantity>2</quantity></order>. В этой схеме id и quantity обязательны. comment можно не передавать. Возможность пропустить элемент не означает разрешение передать null. Ограничения типов XML Schema описаны в спецификации W3C.

Явные правила преобразования

Корневой order преобразуем в JSON-объект без дополнительной обёртки. id сохраняем строкой, quantity — целым числом. Отсутствующий comment не добавляем. Если comment присутствует пустым элементом, сохраняем пустую строку. null в этом учебном договоре запрещён. Неизвестные поля отклоняем.

Это выбранные правила интеграции, а не универсальный стандарт XML–JSON. Система, которой нужна обёртка order или другое обращение с пустыми значениями, должна зафиксировать другой договор. Изменять правило во время конвертации нельзя.

Соответствующая JSON Schema

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "type": "object",
  "required": ["id", "quantity"],
  "additionalProperties": false,
  "properties": {
    "id": {"type": "string", "pattern": "^O[0-9]{3}$"},
    "quantity": {"type": "integer", "minimum": 1},
    "comment": {"type": "string"}
  }
}

Корректный результат для исходного XML: {"id":"O007","quantity":2}. Значение "2" вместо числа уже не соответствует этому договору, хотя текст XML quantity состоит из символов. Тип задаёт схема, а не внешний вид исходной записи.

Не переносите регулярные выражения между XSD и JSON Schema вслепую: у языков выражений различается семантика. В этом примере длина XSD и якоря JSON-паттерна явно ограничивают весь идентификатор четырьмя символами.

Контрольные случаи

СлучайОжидание JSON-проверкиПричина
id O007, quantity 2ПринятСоответствует типам и обязательности
Нет quantityОтклонёнОбязательное поле
quantity равен 0ОтклонёнНиже minimum 1
quantity равен строке «2»ОтклонёнНеправильный тип
comment равен nullОтклонёнДопускается строка, не null
Добавлено поле urgentОтклонёнНеизвестное свойство

Проверка lxml 5.3.0 принимает исходный XML и вариант с пустым comment; отклоняет отсутствие quantity, ноль, неизвестный элемент и слишком длинный id. Проверка jsonschema 4.23.0 принимает оба корректных JSON-варианта и отклоняет шесть нарушений. В отчёте валидаторов сохранены входы, нарушенные ограничения и исходы.

Что остаётся проверить в реальной интеграции

Даже валидные XML и JSON не доказывают правильность преобразования. Проверьте сохранение значения id, числовое значение quantity, порядок обработки повторяющихся элементов и различение пустого и отсутствующего comment. Для больших целых дополнительно согласуйте диапазон чисел принимающей системы.

Владелец интеграции утверждает таблицу соответствий; валидаторы проверяют выбранные ограничения. Сохраните XSD, JSON Schema, XML и JSON одной версии. При следующем изменении контракта начните со сверки версий требований, затем повторите те же отрицательные случаи.

Вопросы по разбору

Можно ли проверить JSON непосредственно по XSD?

Нет. XSD проверяет XML. Для выбранного преобразования нужна отдельная JSON Schema и проверка того, что значения сохранены.

Отсутствующий comment и null равнозначны?

В этом договоре нет. Отсутствие comment разрешено, null запрещён; присутствующий пустой элемент преобразуется в пустую строку.

Почему quantity в JSON должно быть числом?

В таблице соответствий для xs:positiveInteger выбран JSON integer с minimum 1. Строка «2» этому договору не соответствует.

Можно ли переносить XSD-паттерн без изменений?

Сначала проверьте семантику обоих диалектов. В примере XSD ограничивает длину id, а JSON-паттерн явно закрепляет начало и конец строки.

Что именно доказали валидаторы?

Они проверили перечисленные XML и JSON по схемам. Сохранение значений, допустимый диапазон принимающей системы и правила других XML-конструкций требуют отдельных проверок.

Автор: Иннокентий Бодров, автор Аналитической мастерской.