Преобразуйте JSON в типы TypeScript!

Введите JSON, чтобы получить интерфейсы TypeScript! Поддержка: TypeScript interface. TypeORM · Sequelize · Mongoose — во вкладках выше.
JSON
Результат
 

Преобразуйте JSON в типы TypeScript!

Этот инструмент читает значение JSON и пишет для него объявления interface на TypeScript. Ключи сохраняются в точности как есть; массивы объектов объединяются в один интерфейс, ключи, которые есть лишь в части элементов, получают ?, а смешанные значения становятся union-типами.

Используйте, чтобы типизировать ответы fetch или axios на фронтенде, объявить возвращаемые типы для API-роутов Next.js или обработчиков Express, или в любой ситуации, когда бэкенд документирует только примеры ответов без определений типов.

Как пользоваться

  1. Вставьте JSON ответа, например скопированный со вкладки Network в DevTools.
  2. Введите имя корневого интерфейса в Имя типа (например, ChannelHistory); оно сохраняется в URL как ?name=.
  3. Сохраните вывод в файл вроде types.ts и используйте через import type { ChannelHistory } from "./types".

Пример

Вход (JSON)
{
  "channel": "general",
  "messages": [
    { "id": "m1", "user": "kim", "text": "deploy done", "reactions": ["+1"] },
    { "id": "m2", "user": "lee", "text": null, "edited": true, "attachment": { "type": "image", "url": "https://cdn.example.com/a.png" } }
  ],
  "cursor": 42
}
Результат (TypeScript)
export interface ChannelHistory {
  channel: string;
  messages: Message[];
  cursor: number;
}

export interface Message {
  id: string;
  user: string;
  text: string | null;
  reactions?: string[];
  edited?: boolean;
  attachment?: Attachment;
}

export interface Attachment {
  type: string;
  url: string;
}

Оба сообщения объединены в один интерфейс Message; reactions, edited и attachment встречаются лишь в одном из них, поэтому получают ?. text смешивает строку и null, что даёт string | null. Интерфейсы элементов получают имя ключа в единственном числе (messages → Message).

Возможности

  • Каждое объявление — export interface, готовый к импорту в других местах.
  • Ключи JSON не переименовываются, так что типы один к одному совпадают с объектом ответа; ключи, не являющиеся корректными идентификаторами ("a-b", "2fa"), берутся в кавычки.
  • Массивы объектов объединяют ключи всех элементов; ключи, отсутствующие в части элементов, становятся необязательными (?:).
  • Смешанные типы дают union (string | number); null добавляется последним как | null. Смешанные массивы становятся (string | number)[].
  • У пустых массивов нет типа элемента для вывода, и они становятся unknown[].
  • Массив верхнего уровня дополнительно даёт псевдоним вроде export type Root = RootItem[];.

Сценарии использования

Типизация ответов fetch и axios

Передайте тип как дженерик, например const res = await axios.get<ChannelHistory>(url), и редактор предупредит, что res.data.messages[0].text может быть null.

Сторонние API без типов

Для внутренних или внешних API без SDK или пакета @types одного примера ответа достаточно, чтобы получить файл определений типов и поделиться им с командой.

Mock-данные и пропсы компонентов

Сгенерируйте интерфейсы по mock-JSON из Storybook или тестов и используйте их как типы пропсов компонентов; когда моки разойдутся с компонентами, компилятор об этом скажет.

Примечания и ограничения

  • Интерфейсы стираются при компиляции и не проверяют во время выполнения, что ответ действительно имеет такую форму. Если нужна валидация в рантайме, используйте их вместе с библиотекой схем вроде zod.
  • Все числа — number (без разделения на целые и дробные), а строки с датами — string.
  • Поля с фиксированным набором значений, как "status": "active", выводятся как string; сузьте их до union литералов ("active" | "banned") сами.
  • Одинаковые формы под разными ключами получают каждая свой интерфейс, а конфликтующие имена — числовой суффикс вроде Profile2.

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

Можно ли получить псевдонимы type вместо интерфейсов?

Псевдоним type используется только для массива или примитива верхнего уровня; объекты всегда interface. Если переписать export interface X { ... } как export type X = { ... };, для этой цели поведение будет тем же.

Почему необязательность (?) и | null разделены?

Они означают разное: ? говорит, что ключа может не быть (undefined), а | null — что ключ есть, но со значением null. При включённом strictNullChecks эти два случая обрабатываются по-разному.

Почему ключи не преобразуются в camelCase?

Тип TypeScript описывает реальный объект, так что переименованные ключи перестали бы совпадать с ответом. Если в коде нужен camelCase, определите отдельный тип для результата вашей функции маппинга.

Мне нужны ORM-сущности (TypeORM, Sequelize, Mongoose).

Эта страница выдаёт только простые объявления типов. Вкладки TypeORM, Sequelize и Mongoose вверху генерируют код сущностей и моделей из того же JSON.