API и интеграции

Что такое JSON?

JSON (JavaScript Object Notation) — это текстовый формат обмена данными, в котором информацию записывают парами «ключ — значение». Его понимают все языки программирования, и именно в нём чаще всего отвечают современные API.

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

JSON заменил XML как основной формат для веб-API: он компактнее, проще и легко превращается в структуры данных в коде. В AI-разработке в JSON модель возвращает вызовы инструментов при function calling.

Где применяется

JSON используют не только в API. В нём хранят настройки проектов — package.json в Node.js, tsconfig.json, composer.json, — пишут структурированные логи, описывают конфигурации инфраструктуры и передают данные между микросервисами.

Базы данных поддерживают JSON как полноценный тип: PostgreSQL и MySQL хранят его в колонке и ищут по отдельным полям внутри. В работе с языковыми моделями JSON — главный способ получить от модели ответ, который сможет обработать программа.

Пример

Ответ API на запрос одного заказа может выглядеть так: номер заказа, статус оплаты, сумма, данные клиента и список товаров.

{
  "order_id": "A-10427",
  "paid": true,
  "total": 4900,
  "customer": {
    "name": "Анна",
    "city": "Киев"
  },
  "items": [
    { "sku": "JV-01", "qty": 1 },
    { "sku": "PY-07", "qty": 2 }
  ]
}

Объект с вложенным объектом и списком — типичный ответ API.

Частые вопросы

Чем JSON отличается от XML?

XML описывает данные тегами, поддерживает атрибуты, схемы и пространства имён — он мощнее, но громоздче. JSON компактнее, легче читается и напрямую соответствует объектам и массивам в коде. Поэтому веб-API почти полностью перешли на JSON.

Можно ли писать комментарии в JSON?

В стандартном JSON комментариев нет, и строгая проверка выдаст ошибку. Это обходят по-разному: добавляют поле вроде _comment, переносят настройки в YAML, где комментарии есть, или используют формат JSONC, который понимают редакторы кода, но не API.

Чем JSON отличается от объекта JavaScript?

JSON — это текст, а объект JavaScript — структура в памяти программы. В JSON ключи всегда в двойных кавычках, и в нём нельзя хранить функции, даты или undefined. Для преобразования между ними используют JSON.parse и JSON.stringify.

Что такое JSON Schema?

Это описание того, каким должен быть документ: какие поля обязательны, какого они типа, какие значения допустимы. По схеме автоматически проверяют входные данные и создают документацию. Тем же способом описывают инструменты, которые вызывает языковая модель.

Обучение программированию в OWU

Освойте профессию в IT на практических курсах с менторами и реальными проектами.

Выбрать курс