Des types TypeScript à partir de données réelles
Écrire à la main les interfaces de la réponse d'une API est long, et il est facile de se tromper sur un champ. Cet outil lit un exemple de JSON et génère les types TypeScript qui le décrivent.
Chaque objet imbriqué a sa propre interface, nommée d'après sa clé (address → Address). Dans les listes d'objets, tous les éléments sont fusionnés en un seul type : si une clé manque dans certains, elle est marquée optionnelle avec « ? », et si un champ contient des valeurs de types différents, une union est créée, comme string | number. Les types identiques ne sont déclarés qu'une fois.
Vous pouvez choisir le nom du type principal, interface ou type, l'ajout d'export et le marquage des propriétés en readonly.
Comment générer des types TypeScript depuis du JSON
- Collez un exemple de JSON, comme la réponse de votre API.
- Saisissez le nom du type principal (« Root » par défaut).
- Choisissez interface ou type, et si vous voulez export et readonly.
- Cliquez sur « Générer le TypeScript » et copiez le code ou téléchargez le fichier .ts.
Quand l'utiliser
- Typer la réponse d'une API REST dans un projet React, Angular, Vue ou Node.
- Créer les types d'un fichier de configuration JSON.
- Documenter la forme des données échangées entre deux services.
- Démarrer les modèles d'un nouveau projet à partir de données d'exemple.
Foire Aux Questions
Comment détermine-t-il quels champs sont optionnels ?
Dans les listes d'objets, une clé présente dans tous les éléments est obligatoire, et une clé absente d'au moins un élément est optionnelle (?). Avec un seul objet d'exemple, toutes sont obligatoires ; pour détecter les optionnelles, collez une liste avec plusieurs exemples.
Quel type donne-t-il à null ou à une liste vide ?
Une valeur null est typée null (ou unie au type trouvé dans d'autres exemples, comme string | null). Une liste vide devient unknown[], car il n'y a aucun exemple pour savoir ce qu'elle contient.
Valide-t-il les données à l'exécution ?
Non. Les types TypeScript n'existent qu'à la compilation. Si vous avez besoin d'une validation à l'exécution, utilisez une bibliothèque comme Zod à partir de ces types.
Mes données sont-elles envoyées à un serveur ?
Non. Tout est traité dans votre navigateur avec JavaScript. Le texte que vous collez et les fichiers que vous ouvrez ne quittent pas votre appareil : vous pouvez utiliser des données internes ou clients en toute tranquillité.
Est-ce gratuit ?
Oui. Vous pouvez essayer l'outil gratuitement sur un document (collé ou un fichier) et modifier les options autant de fois que vous le souhaitez ; les tentatives qui aboutissent à une erreur ne consomment pas l'essai. Pour un usage illimité et le traitement de plusieurs fichiers à la fois, ToolStudio Pro coûte 1,99 € par mois et inclut tous les outils.
