Форматировщик и валидатор JSON

Что делает форматировщик и валидатор JSON

JSON — JavaScript Object Notation, стандартизированный как RFC 8259 — это универсальный язык веб-API, конфигурационных файлов и обмена данными. Этот инструмент выполняет три связанные задачи с любым JSON, который вы вставите. Он красиво форматирует (pretty-print) его с чистыми, последовательными отступами, чтобы сплошная стена текста превратилась в читаемое дерево; он минифицирует его, убирая каждый лишний пробел и перенос строки, чтобы уменьшить размер данных; и он валидирует его, сразу сообщая, корректно ли сформирован документ, а если нет — где именно парсер сдался. Вы обращаетесь к нему постоянно: читая минифицированный ответ API, приводя в порядок конфигурационный файл, выявляя лишнюю запятую, которую отвергает сервис, или сжимая тело запроса перед отправкой.

JSON обманчиво строг. Вся его система типов невелика — объекты (карты ключ/значение), массивы (упорядоченные списки), строки, числа, литералы true, false и null — а его синтаксические правила неумолимы. Ключи и строки должны использовать двойные кавычки, никогда одинарные; комментариев нет; и никакая завершающая запятая не допускается после последнего элемента объекта или массива. Именно эти три правила вызывают подавляющее большинство ошибок «недействительный JSON».

Как работают форматирование, минификация и валидация

Под капотом инструмент разбирает ваш текст с помощью встроенного в браузер, соответствующего стандартам парсера JSON — это тот же движок, который используют ваши приложения, так что то, что проходит здесь, проходит и там. После разбора в структуру в памяти форматирование повторно сериализует её с выбранным вами отступом — два пробела, четыре пробела или табуляция — вкладывая каждый уровень на шаг глубже, чтобы форма данных была очевидна с первого взгляда. Минификация повторно сериализует ту же структуру без отступов и без незначащих пробелов, создавая самое компактное действительное представление, которое как раз и нужно для хранения или передачи. Валидация просто пытается выполнить разбор и сообщает результат: успех или сообщение парсера об ошибке, описывающее, что он ожидал и примерно где остановился.

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

Примеры, сценарии использования и подводные камни

Вставьте компактный ответ вроде {"user":{"id":7,"tags":["a","b"],"active":true}}, и форматирование развернёт его в дерево с отступами, которое действительно можно прочитать; минификация делает обратное. Конфигурационный файл, который сервис постоянно отвергает, после форматирования часто обнаруживает единственную неуместную запятую или комментарий, проскользнувший по привычке из JavaScript. Повседневные применения включают проверку payload’ов вебхуков, сравнение двух ответов API после форматирования обоих и подготовку минимального тела запроса.

• JSON — это не объектный литерал JavaScript: никаких комментариев, никаких завершающих запятых, и каждый ключ должен быть строкой в двойных кавычках.
• Числа — это числа двойной точности IEEE-754, поэтому очень большие целые (свыше 2^53) могут незаметно потерять точность — отправляйте их как строки, если точность важна.
• Форматирование сохраняет порядок ключей так, как они записаны; сам JSON определяет объекты как неупорядоченные, поэтому не полагайтесь на порядок для корректности.
• Начальная метка порядка байтов (BOM) или обёртка из пары кавычек после копирования — распространённая причина ошибки «unexpected token».

Ваша приватность

Весь разбор, форматирование, минификация и валидация происходят на сто процентов локально в вашем браузере. Ваш JSON — который может быть ответом API, полным персональных полей, токеном доступа или приватной конфигурацией — никогда не покидает ваше устройство, никогда не отправляется ни на один сервер и никогда не логируется. Ничего не загружается и ничего не сохраняется после того, как вы закрываете вкладку. Для данных, которые часто содержат учётные данные и записи клиентов, выполнение работы на устройстве — единственный ответственный дизайн, и именно так построен этот валидатор.