.json.
TypeScript Как это работает
Этот инструмент читает пример JSON и определяет его структуру, чтобы сгенерировать эквивалентные классы или типы на выбранном вами языке: C#, C++, Go, Java, JavaScript, Kotlin, PHP, Python, Rust или TypeScript.
Из ключей и типов значений JSON он выводит имена свойств и их типы (текст, число, логическое значение, списки). Вложенные объекты становятся собственными классами или типами.
Это быстрый способ создать модели данных для работы с API, не написав их вручную. Можно вставить JSON или загрузить файл; всё обрабатывается в вашем браузере.
Примеры
{ "id": 1, "name": "Ada" }interface RootObject {
id: number;
name: string;
}Вывод на TypeScript: каждое свойство получает тип, выведенный из значения.{ "user": { "id": 1 } }Для вложенного объекта «user» создаётся отдельный класс или тип.Объекты внутри объектов создают собственные модели, связанные свойством.Сценарии использования
- Создать классы клиента, работающего с API, из примера JSON-ответа.
- Преобразовать JSON конфигурации или вебхука в строгие типы для вашего языка.
- Избежать рутинной работы по ручному набору моделей со множеством свойств.
Часто задаваемые вопросы
Как он определяет тип каждого свойства?
По значению из примера: «текст» — строка, 36 — число, true/false — булево, а [ ] — список типа своих элементов. Поэтому лучше использовать JSON с репрезентативными значениями.
Что происходит со значением null?
null не несёт информации о типе, поэтому его нельзя определить наверняка. Если свойство может быть null, включите пример с реальным значением и настройте допустимость null в сгенерированном коде.
Генерирует ли он модели из массива в корне?
Да. Он берёт первый элемент массива как шаблон объекта и генерирует модель этого элемента, который представляет весь список.
Соблюдают ли сгенерированные имена соглашение языка?
Они выводятся из ключей JSON, адаптируясь к выбранному языку. Всегда проверяйте результат, особенно если в ключах есть специальные символы или зарезервированные имена.