json в машинописный

Преобразователь JSON в TypeScript считывает пример значения JSON - ответ API, файл конфигурации, запись базы данных - и записывает интерфейсы TypeScript, которые его описывают Вложенные объекты становятся собственными именованными интерфейсами, массивы объектов объединяются в единый интерфейс элементов, а не в разрастающееся объединение, а ключи, которые нулевые или отсутствуют в некоторых записях, помечаются необязательными. Вы вставляете уже имеющиеся данные; вы получаете типы, которые в противном случае вы бы написали от руки.

Ввод ответа API вручную утомителен и подвержен ошибкам определенным образом: вы вводите то, что вы * думаете* конечная точка возвращает, а не то, что она возвращает. поля, которые вы никогда не замечали, опускаются, целое число, которое иногда нулевое, вводится как `number`, и ошибка всплывает во время выполнения в производстве, а не в вашем редакторе. Создание типов прямо из реальной полезной нагрузки закрывает этот пробел, потому что форма, против которой вы компилируете, - это форма, которую отправил сервер.

Все работает в вашем браузере. механизм вывода - это TypeScript без зависимостей, а не оболочка вокруг удаленного сервиса, поэтому полезные нагрузки, которые обычно несут токены доступа, записи клиентов и внутренние идентификаторы, никогда не покидают страницу. Выберите интерфейсы или псевдонимы типов, переключите ключевое слово `export` и модификаторы `readonly`, выберите ширину отступа, затем скопируйте вывод или загрузите файл.ts.

Быстрый способ увидеть, что JSON к TypeScript конверсия дает вам является встроенный сэмпл. Нажмите Load Sample, затем Generate. вы получаете три интерфейса JSON к TypeScript: `Rooth`, `Owner` и `Release`. Второй релиз не имеет `notes` ключ, поэтому объединенный интерфейс `Release` читает `notes?: string, и `retiredAt является нулевым в единственной записи, так что он становится `retiredAt?: null`.That является честным результатом, потому что один null не дает доказательств реального типа. Чтобы конвертировать JSON в TypeScript для реальной конечной точки, вставьте несколько записей, чтобы вывод имел больше для сравнения.

Сгенерированные интерфейсы описывают предоставленную вами выборку, а не API, который вы вызываете, и это различие - весь риск. поле, которое случайно присутствует в каждом объекте вашей выборки, отмечено необходимым, даже если сервер иногда его пропускает, а поле, которое в выборке является нулевым, нельзя отличить от поля, которое всегда является нулевым. Пустые массивы - самый ясный случай: массив без элементов не дает никакой информации о том, что он содержит. Объединение массивов помогает здесь, объединяя каждый объект в списке в один интерфейс и отмечая ключи, которые отсутствуют в некоторых записях, как необязательные, поэтому более крупная и разнообразная выборка создает более честный тип. Где API имеет схему или документ OpenAPI, сгенерируйте из этого вместо этого и используйте это для изучения недокументированного ответа.