JSON в TypeScript

Пример

Ввод:

{ "id": 1, "name": "Alice", "age": null, "tags": ["admin", "user"], "address": { "city": "Madrid" } }

Результат:

interface User {
  id: number;
  name: string;
  age: number | null;
  tags: string[];
  address: Address;
}

interface Address {
  city: string;
}

Сопоставление типов

Необязательное поле против поля, допускающего null

• foo?: string, поле может отсутствовать в объекте. Применяется проверка на undefined.
• foo: string | null, поле всегда присутствует, но может быть явно равно null.
• foo?: string | null, может отсутствовать ИЛИ быть равным null.

В самом JSON нет undefined, но разные API по-разному сигнализируют об отсутствии поля. Согласуйте со семантикой вашего API.

• REST API обычно опускают отсутствующие поля -> ?:.
• GraphQL всегда возвращает каждое запрошенное поле -> | null.
• Некоторые SDK используют оба подхода в разных контекстах.

Объединённые типы против литеральных типов

Если инструмент видит одно и то же строковое поле с небольшим набором значений в разных образцах ("status": "pending", "active", "archived"), он может вывести объединение строковых литералов:

status: "pending" | "active" | "archived";

Включите «выводить объединения строковых литералов», если вам это нужно.

Частые ошибки

• Вывод по одному образцу. Каждое поле становится обязательным; допустимость null наблюдать невозможно. Для более точных типов передайте 5-10 разнообразных образцов.
• Пустые массивы. "tags": [] не даёт информации о типе, генератор выдаёт unknown[]. Предоставьте образец хотя бы с одним элементом.
• Массивы смешанного типа. [1, "two", true] даёт (number | string | boolean)[]. Обычно это означает, что JSON стоит переработать, а не типизировать как есть.
• Числовые строковые ключи. JSON {"1": "a", "2": "b"} в TypeScript всё равно является объектом (Record<string, string>), а не массивом. Генератор обрабатывает это правильно.