JSON vers TypeScript

Le convertisseur JSON vers TypeScript lit un exemple de valeur JSON - une réponse API, un fichier de configuration, un enregistrement de base de données - et écrit les interfaces TypeScript qui le décrivent Les objets imbriqués deviennent leurs propres interfaces nommées, les tableaux d'objets sont fusionnés en une interface à élément unique plutôt qu'en une union tentaculaire, et les clés nulles ou manquantes dans certains enregistrements sont marquées comme facultatives Vous collez des données que vous possédez déjà ; vous obtenez des types que vous écririez autrement à la main.

Taper une réponse API à la main est fastidieux et sujet aux erreurs d'une manière spécifique : vous tapez ce que vous * pensez * le point final renvoie, pas ce qu'il a renvoyé Les champs que vous n'avez jamais remarqué sont omis, un entier qui est parfois nul est tapé comme ```, et l'erreur fait surface au moment de l'exécution en production plutôt que dans votre éditeur La génération de types directement à partir d'une charge utile réelle comble cet écart, car la forme que vous compilez est la forme envoyée par le serveur.

Tout tourne dans votre navigateur Le moteur d'inférence est TypeScript sans dépendance, pas un wrapper autour d'un service distant, donc les charges utiles - qui transportent régulièrement les jetons d'accès, les dossiers clients et les ID internes - ne quittent jamais la page Choisissez des interfaces ou tapez des alias, basculez le mot-clé `export` et les modificateurs `readonly`, choisissez votre largeur d'indentation, puis copiez la sortie ou téléchargez un fichier.ts.

Un moyen rapide de voir ce que vous donne la conversion JSON en TypeScript est l'échantillon intégré Appuyez sur Load Sample, puis Générez Vous obtenez trois interfaces JSON à TypeScript : `Root`, `Owner` et `Release` La deuxième version n'a pas de clé `notes, donc l'interface fusionnée `Release` reads ? : string`, et `retiredAt` is null in the only record, so it becs `redAt ? : null` That is the honnet result, car one null donne aucune preuve du vrai type Pour convertir JSON en TypeScript pour un point final réel, collez plusieurs enregistrements.

Les interfaces générées décrivent l'échantillon que vous avez fourni, pas l'API que vous appelez, et cette distinction est tout le risque Un champ qui se trouve être présent dans chaque objet de votre échantillon est marqué requis même si le serveur l'omet parfois, et un champ qui est nul dans l'échantillon ne peut pas être distingué d'un qui est toujours nul Les tableaux vides sont le cas le plus clair : un tableau sans éléments ne donne aucune information sur ce qu'il contient La fusion de tableaux aide ici en combinant chaque objet d'une liste dans une interface et en marquant les clés qui manquent dans certaines entrées comme facultatives, donc un échantillon plus grand et plus varié produit un type plus honnête Où l'API a un schéma ou un document OpenAPI, générer à partir de cela et utiliser cette réponse non document à la place.