Блог

Как отформатировать JSON и скопировать JSON Pointer к значению

Отформатируйте однострочный ответ API в браузере и скопируйте JSON Pointer из дерева. На примерах показаны также минификация и проверка синтаксиса.

В английском интерфейсе однострочный JSON показан рядом с результатом форматирования.

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

Сделайте однострочный ответ читаемым

Вставьте этот пример в поле «Входной JSON».

{"items":[{"sku":"A-001","stock":12},{"sku":"B-002","stock":0}]}
  1. Установите для «Отступ» значение 2 и нажмите «Форматировать →».
  2. В поле «Результат» найдите второй элемент массива items. У товара с sku B-002 значение stock равно 0.
  3. Чтобы сохранить результат в файле, нажмите «Копировать», вставьте его в редактор и сохраните. Если нужна компактная строка, перед копированием нажмите «Минифицировать →».
В английском интерфейсе в поле ввода виден список товаров, а в поле вывода показан JSON с отступами в два пробела.
Раздельные поля ввода и вывода позволяют сравнить исходную строку с отформатированной структурой.

Найдите в дереве путь к остатку второго товара

  1. Оставьте исходные данные и нажмите «Дерево JSON».
  2. Раскройте items и [1], затем выберите "stock": 0. Индексация начинается с нуля, поэтому [1] соответствует второму элементу.
  3. Убедитесь, что выбранный JSON Pointer равен /items/1/stock, и нажмите «Копировать путь». Запишите путь вместе с указанием, какой ответ вы проверяли.
В английском интерфейсе в дереве открыт второй элемент массива items, и для выбранного stock показан путь /items/1/stock.
В поле пути показано расположение выбранного значения. Само значение равно 0.

В JSON Pointer косая черта в ключе записывается как ~1, а тильда как ~0. Например, отдельный ключ stock/on-hand записывается как stock~1on-hand. См. синтаксис в RFC 6901.

Проверьте синтаксис, если форматирование не удаётся

Если записать второй элемент как {"sku":"B-002","stock":0,}, запятая перед закрывающей фигурной скобкой вызовет ошибку. Нажмите «Проверить» для проверки. Если браузер сообщает позицию ошибки, инструмент покажет строку и столбец. Удалите запятую и повторите проверку кнопкой «Проверить» перед форматированием.

Кнопка «Проверить» проверяет синтаксис JSON. Чтобы узнать, обязателен ли stock и допустимы ли отрицательные значения, обратитесь к спецификации или схеме API.