JSON vers TypeScript

Générez une interface TypeScript à partir d'un exemple JSON.

Entrée
Résultat

Exemples d'utilisation

Esquisser rapidement un type pour une réponse d'API

Collez un exemple de réponse JSON de votre serveur et obtenez un brouillon d'interface TypeScript à coller directement dans votre projet.

Séparer automatiquement les objets imbriqués en interfaces distinctes

Quand votre JSON contient un autre objet, celui-ci obtient sa propre interface nommée d'après le champ, gardant le tout bien organisé.

Marquer des champs comme optionnels quand les éléments d'un tableau diffèrent

Quand les objets d'un tableau ne partagent pas tous les mêmes champs, ils sont fusionnés en une seule interface avec « ? » marquant les champs absents de certains éléments.

Prototyper des types pour une charge utile GraphQL ou de webhook

Collez un exemple de charge utile comme '{"event": "order.created", "data": {"id": "ord_1", "total": 42.5}}' pour obtenir rapidement des interfaces typées pour un gestionnaire de webhook, sans les écrire à la main.

Vérifier comment les valeurs null sont typées

Incluez un champ comme '{"middleName": null}' dans votre exemple pour voir comment l'outil représente les champs nullables dans l'interface générée.

Référence rapide

JSON values → TypeScript types

JSONTypeScript
"hello"type Root = string;
42type Root = number;
3.14type Root = number;
truetype Root = boolean;
nulltype Root = null;
[]type Root = unknown[];
[1, 2, 3]type Root = number[];
["a", "b"]type Root = string[];
[1, "a", true]type Root = (number | string | boolean)[];
[1, null]type Root = (number | null)[];
[[1, 2], [3]]type Root = number[][];
{}interface Root { }

JSON objects → TypeScript interfaces

JSONTypeScript
{"id": 1, "name": "Ada"}interface Root { id: number; name: string; }
{"deletedAt": null}interface Root { deletedAt: null; }
{"tags": ["a", "b"]}interface Root { tags: string[]; }
{"user": {"id": 1}}interface User { id: number; } interface Root { user: User; }
{"items": [{"id": 1}, {"id": 2, "note": "x"}]}interface Item { id: number; note?: string; } interface Root { items: Item[]; }
{"categories": [{"name": "x"}]}interface Category { name: string; } interface Root { categories: Category[]; }
{"first-name": "Ada"}interface Root { "first-name": string; }
{"a": {"x": 1}, "b": {"x": 2}}interface A { x: number; } interface Root { a: A; b: A; }

Questions fréquentes

Mon JSON est-il envoyé à un serveur?

Non. Toute la conversion se fait entièrement dans votre navigateur, et ce que vous saisissez n'est jamais envoyé à un serveur.

Puis-je utiliser le code généré tel quel?

Il est déduit d'un seul exemple JSON, il peut donc ne pas couvrir toutes les variations possibles de vos données réelles. Considérez l'interface générée comme un point de départ et ajustez-la selon vos besoins.

Reconnaît-il les chaînes de date comme un type Date?

Non. JSON n'a pas de type de date dédié, donc toute chaîne est traitée comme string. Si vous voulez la traiter comme une date, ajustez le code généré manuellement.

Que se passe-t-il si la même forme d'objet apparaît plusieurs fois?

Les objets de structure identique réutilisent une seule interface au lieu d'en générer des doublons.

Comment les tableaux vides sont-ils typés?

Comme un tableau vide ne donne aucun indice sur le type de ses éléments, il est typé 'unknown[]'. Ajoutez au moins un élément d'exemple au tableau si vous voulez un type d'élément plus précis.

Quel type TypeScript reçoit une valeur null?

Un champ dont la valeur d'exemple est null est typé 'null'. Si vous savez que le champ peut aussi contenir d'autres types, comme une chaîne ou être absent, vous devrez élargir à la main le type généré, par exemple en 'string | null'.

L'ordre des champs de mon JSON affecte-t-il l'interface générée?

Non. Les champs sont listés dans l'interface générée dans le même ordre que dans votre entrée, mais les réordonner dans le JSON source n'a aucun effet sur les types générés eux-mêmes.