Перейти к содержимому
POST AI agent ready /v1/json/format

API форматирования JSON — Pretty-Print с пользовательским отступом

Принимает компактную или плохо отформатированную строку JSON и возвращает ее с одинаковыми отступами и разрывами строк. Настройте размер отступа (обычно 2 или 4 пробела) в соответствии со стилем вашего проекта.

Parameters

stringrequired

The JSON string to format.

number

Number of spaces per indentation level.

Code examples

curl -X POST https://api.botoi.com/v1/json/format \
  -H "Content-Type: application/json" \
  -d '{"json":"{\"name\":\"botoi\",\"version\":2}","indent":2}'

When to use this API

Форматирование ответов API для ведения журнала

Красиво распечатывайте тела ответов API перед записью их в файлы журналов, чтобы разработчики могли сканировать их во время отладки.

Создайте программу просмотра файлов конфигурации

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

Стандартизация отступов в конвейерах CI

Запустите эту конечную точку на этапе CI, чтобы убедиться, что все возвращенные файлы JSON соответствуют единому правилу отступа в 2 или 4 пробела.

Frequently asked questions

Какие уровни отступов поддерживаются?
Подойдет любое положительное целое число, хотя наиболее распространенными являются 2 и 4. По умолчанию — 2 пробела.
Форматирование каким-либо образом меняет данные?
Нет. Выходные данные семантически идентичны входным. Изменяются только пробелы и разрывы строк.
Что произойдет, если входной JSON недействителен?
API возвращает ошибку с указанием места сбоя синтаксического анализа, поэтому вы можете исправить проблему синтаксиса.
Могу ли я отформатировать JSON с отступами табуляции вместо пробелов?
В настоящее время API поддерживает только отступы на основе пробелов. Установите параметр отступа на желаемое количество пробелов.

Get your API key

Free tier includes 5 requests per minute with no credit card required. Upgrade for higher limits.