Как пользоваться инструментом «Форматирование JSON»
- Вставьте или откройте JSONВставьте JSON из ответа API, лога или конфигурации либо откройте файл .json с компьютера.
- Выберите форматирование2 пробела, 4 пробела или табуляция и при желании сортировка ключей по алфавиту.
- Форматируйте, минифицируйте или проверьтеНажмите «Форматировать / украсить» для читаемого вида, «Минифицировать» для минимального размера или «Только проверить» для проверки синтаксиса.
- Скопируйте или скачайтеСкопируйте результат в буфер обмена или скачайте как файл .json.
Почему разработчики выбирают этот инструмент
- Точные ошибкиДля некорректного JSON показываются строка и столбец проблемы и подсказка о частых ошибках вроде одинарных кавычек или лишних запятых.
- Форматирование и минификацияПереключайтесь между читаемыми отступами и компактной однострочной записью одним кликом.
- Сортировка ключейКлючи по алфавиту упрощают сравнение двух JSON в diff-инструменте.
- Приватность по умолчаниюРазбор выполняет встроенный JSON-движок браузера. Токены, данные клиентов и ключи API не покидают ваш компьютер.
Что такое JSON?
JSON (JavaScript Object Notation) — лёгкий текстовый формат для структурированных данных. Это стандартный способ, которым веб-API передают данные; он встречается в файлах настроек, базах данных вроде MongoDB и в обмене данными между почти любыми языками программирования. Он состоит из объектов ({ }), массивов ([ ]), строк, чисел, логических значений (true/false) и null.
API обычно возвращают JSON, сжатый в одну строку, чтобы экономить трафик. Для машин это идеально, для людей — мучение. Форматтер добавляет переносы строк и отступы, чтобы структура была видна с первого взгляда.
Самые частые синтаксические ошибки
JSON строже, чем JavaScript. Вот ошибки, которые наш валидатор находит чаще всего:
- Одинарные кавычки. Строки и ключи пишутся в двойных кавычках:
{"name": "Иван"}, а не{'name': 'Иван'}. - Запятая в конце. Запятая после последнего элемента, как в
[1, 2, 3,], не допускается. - Ключи без кавычек.
{name: "Иван"}— корректный JavaScript, но некорректный JSON. - Комментарии. В стандартном JSON комментариев нет. Удалите строки
//и/* */. - Особые значения. undefined, NaN и Infinity недопустимы. Используйте null или число.
- Десятичная запятая. В JSON всегда точка:
12.5, а не12,5. - Неэкранированные символы. Переносы строк и двойные кавычки внутри строки нужно писать как
\nи\".
Кириллица внутри JSON полностью допустима как есть, переводить её в коды вида И не нужно.
Форматировать или сжимать?
Отформатированный JSON удобен при разработке, разборе ответов API и хранении файлов настроек в Git: читаемые файлы дают понятные диффы. Сжатый JSON нужен для передачи по сети и хранения в продакшене, где важен каждый байт. Сжатие удаляет только пробелы; данные не меняются.
Можно ли вставлять сюда ответы API?
Да. Многие онлайн-форматтеры отправляют ваши данные на сервер. Этот — нет: форматирование и проверка выполняются в браузере тем же движком JSON, который браузер использует на любом сайте. Можно даже отключить интернет после открытия страницы, и инструмент продолжит работать. И всё же полезная привычка — удалять настоящие пароли и ключи API, прежде чем делиться JSON.