Convertissez du JSON en types TypeScript !

Saisissez du JSON pour le convertir en interfaces TypeScript ! Compatible avec TypeScript interface. TypeORM · Sequelize · Mongoose : dans les onglets ci-dessus.
JSON
Résultat
 

Convertissez du JSON en types TypeScript !

Cet outil lit une valeur JSON et écrit les déclarations interface TypeScript correspondantes. Les clés sont conservées telles quelles ; les tableaux d'objets sont fusionnés en une seule interface, les clés présentes dans seulement certains éléments reçoivent ?, et les valeurs mixtes deviennent des types union.

Utilisez-le pour typer les réponses fetch ou axios côté frontend, déclarer les types de retour des API routes Next.js ou des handlers Express, ou chaque fois qu'un backend ne documente que des exemples de réponses, sans définitions de types.

Mode d'emploi

  1. Collez un JSON de réponse, par exemple copié depuis l'onglet Network des DevTools.
  2. Saisissez le nom de l'interface racine dans Nom du type (par exemple ChannelHistory) ; il est conservé dans l'URL sous la forme ?name=.
  3. Enregistrez la sortie dans un fichier comme types.ts et utilisez-la via import type { ChannelHistory } from "./types".

Exemple

Entrée (JSON)
{
  "channel": "general",
  "messages": [
    { "id": "m1", "user": "kim", "text": "deploy done", "reactions": ["+1"] },
    { "id": "m2", "user": "lee", "text": null, "edited": true, "attachment": { "type": "image", "url": "https://cdn.example.com/a.png" } }
  ],
  "cursor": 42
}
Sortie (TypeScript)
export interface ChannelHistory {
  channel: string;
  messages: Message[];
  cursor: number;
}

export interface Message {
  id: string;
  user: string;
  text: string | null;
  reactions?: string[];
  edited?: boolean;
  attachment?: Attachment;
}

export interface Attachment {
  type: string;
  url: string;
}

Les deux messages sont fusionnés en une seule interface Message ; reactions, edited et attachment n'apparaissent que dans l'un d'eux et reçoivent donc ?. text mélange une chaîne et null, ce qui donne string | null. Les interfaces d'éléments prennent la forme au singulier de la clé (messages → Message).

Fonctionnalités prises en charge

  • Chaque déclaration est une export interface, prête à être importée ailleurs.
  • Les clés JSON ne sont pas renommées : les types correspondent un à un à l'objet de réponse ; les clés qui ne sont pas des identifiants valides ("a-b", "2fa") sont mises entre guillemets.
  • Les tableaux d'objets fusionnent les clés de tous les éléments ; celles absentes de certains éléments deviennent optionnelles (?:).
  • Les types mixtes produisent des unions (string | number) ; null est ajouté en dernier sous la forme | null. Les tableaux mixtes deviennent (string | number)[].
  • Les tableaux vides n'ont pas de type d'élément à inférer et deviennent unknown[].
  • Un tableau de premier niveau produit aussi un alias comme export type Root = RootItem[];.

Cas d'utilisation

Typer les réponses fetch et axios

Passez le type en générique, par exemple const res = await axios.get<ChannelHistory>(url), et l'éditeur vous prévient que res.data.messages[0].text peut valoir null.

API tierces sans typages

Pour des API internes ou externes sans SDK ni package @types, une seule réponse d'exemple suffit à produire un fichier de définitions de types à partager avec l'équipe.

Données fictives et props de composants

Générez des interfaces à partir du JSON fictif de Storybook ou des tests et utilisez-les comme types de props ; quand les mocks s'écartent des composants, le compilateur vous le signale.

Remarques et limites

  • Les interfaces sont effacées à la compilation et ne vérifient pas à l'exécution qu'une réponse a vraiment cette forme. Associez-les à une bibliothèque de schémas comme zod s'il vous faut une validation à l'exécution.
  • Tous les nombres sont number (pas de distinction entier/flottant), et les chaînes de date sont string.
  • Les champs à ensemble de valeurs fixe, comme "status": "active", sortent en string ; restreignez-les vous-même en unions de littéraux ("active" | "banned").
  • Des formes identiques sous des clés différentes reçoivent chacune leur interface, et les noms en conflit reçoivent un suffixe numérique comme Profile2.

FAQ

Puis-je obtenir des alias type au lieu d'interfaces ?

Un alias type n'est utilisé que pour un tableau ou une valeur primitive de premier niveau ; les objets sont toujours des interface. Réécrire export interface X { ... } en export type X = { ... }; se comporte de la même façon pour cet usage.

Pourquoi l'optionnel (?) et | null sont-ils distincts ?

Ils ne veulent pas dire la même chose : ? indique que la clé peut être absente (undefined), tandis que | null indique que la clé est présente avec une valeur null. Avec strictNullChecks activé, vous traitez les deux cas différemment.

Pourquoi les clés ne sont-elles pas converties en camelCase ?

Un type TypeScript décrit l'objet réel : des clés renommées ne correspondraient plus à la réponse. Si vous voulez du camelCase dans votre code, définissez un type séparé pour le résultat de votre fonction de mapping.

J'ai besoin d'entités d'ORM (TypeORM, Sequelize, Mongoose).

Cette page n'émet que de simples déclarations de types. Les onglets TypeORM, Sequelize et Mongoose en haut génèrent du code d'entité et de modèle à partir du même JSON.