Convertissez des types TypeScript en JSON !

Saisissez des interfaces TypeScript pour générer un JSON d'exemple ! Compatible avec TypeScript interface, type. Pratique pour documenter une API et créer des corps de requête de test (mock request body).
TypeScript
Résultat
 

Convertissez des types TypeScript en JSON !

Collez des déclarations TypeScript interface, alias type, enum ou classes et obtenez un document JSON d'exemple qui les satisfait. Les unions de littéraux, Record, les types utilitaires comme Pick, Omit et Partial, et les interfaces chaînées par extends sont tous suivis et remplis.

Utilisez-le avant qu'une API existe pour préparer des données fictives MSW ou json-server, pour créer des props Storybook, ou pour montrer à l'équipe backend exactement quelle forme vous voulez recevoir.

Mode d'emploi

  1. Collez des déclarations de types issues d'un fichier comme types.ts. export, import et des déclarations de fonctions peuvent s'y mêler ; seules les déclarations de types sont lues.
  2. Incluez les types et enums référencés pour qu'ils soient remplis. Les noms de types absents de l'entrée deviennent null.
  3. Il n'y a pas d'options. Le premier type objet qu'aucune autre déclaration ne référence devient la racine : placez en premier celui que vous voulez ; un alias qui instancie un générique, comme type UserPage = Page<User>, est préféré à la déclaration générique elle-même.
  4. Copiez le résultat dans le HttpResponse.json(...) d'un handler MSW, une fixture de test ou les args de Storybook, puis ajustez les valeurs.

Exemple

Entrée (TypeScript)
type Channel = "email" | "sms" | "push";

enum Priority { Low = "low", High = "high" }

interface Notification {
  id: string;
  channel: Channel;
  priority: Priority;
  recipient: { userId: number; locale?: string };
  payload: Record<string, string>;
  readAt: Date | null;
  meta: Pick<Audit, "createdBy">;
}

interface Audit { createdBy: string; createdAt: Date }
Sortie (JSON)
{
  "id": "",
  "channel": "email",
  "priority": "low",
  "recipient": {
    "userId": 0,
    "locale": ""
  },
  "payload": {
    "key": ""
  },
  "readAt": "1970-01-01T00:00:00.000Z",
  "meta": {
    "createdBy": ""
  }
}

Channel est une union de littéraux chaîne : il prend sa première valeur, "email" ; l'enum de chaînes Priority prend la valeur de son premier membre, "low". Record<string, string> devient un objet à une seule clé "key", Date | null se résout vers le côté non nul sous forme de chaîne ISO, et Pick<Audit, "createdBy"> ne garde que la clé sélectionnée. Le locale? optionnel est inclus lui aussi.

Fonctionnalités prises en charge

  • Primitifs : string → "", number/bigint → 0, boolean → false, any/unknown → null, Date → 1970-01-01T00:00:00.000Z (le format de Date.toJSON()).
  • Les types littéraux utilisent leur valeur, les unions prennent le premier membre qui n'est pas null/undefined, et les intersections (A & B) ainsi que interface ... extends fusionnent les propriétés.
  • Un enum utilise la valeur de son premier membre, ou 0 pour un enum numérique sans initialiseurs.
  • Les tableaux, Array<T> et Set<T> reçoivent un élément d'exemple ; les tuples reçoivent une valeur par position ; Record<K, V>, Map et les signatures d'index deviennent {"key": V}.
  • Prend en charge les types utilitaires Partial, Required, Readonly, NonNullable, Pick et Omit.
  • Les méthodes et les propriétés de type fonction n'existent pas en JSON et sont supprimées ; dans les classes, les champs static, les accesseurs get/set et les champs @Exclude() sont exclus.
  • Les tableaux autoréférents (children: TreeNode[]) sont coupés en tableaux vides.

Cas d'utilisation

Réponses fictives pour MSW ou json-server

Avant que le backend soit prêt, générez des données fictives à partir des types de réponse de l'API. L'interface peut être construite d'abord, et passer plus tard à la vraie API conserve les mêmes types.

Props pour Storybook et les tests

Créez un objet par défaut à partir du type de props d'un composant pour les args d'une story ou les données de rendu de React Testing Library. Toutes les propriétés obligatoires sont présentes : aucune erreur de type à pourchasser.

S'accorder sur les formats de requête avec le backend

Transformez un type de requête frontend en JSON et collez-le dans une doc de conception d'API ou un ticket : les développeurs backend qui n'utilisent pas TypeScript lisent la structure immédiatement.

Remarques et limites

  • Les propriétés optionnelles (?) sont toujours incluses ; supprimez vous-même des clés pour tester des réponses où elles sont absentes.
  • Les paramètres génériques sont substitués là où le type est utilisé : avec type UserPage = Page<User>, items: T[] est rempli avec User, et les valeurs par défaut comme <T = string> s'appliquent quand aucun argument n'est donné. Les types conditionnels à l'intérieur des génériques ne sont toujours pas évalués.
  • Les types d'accès indexé comme T["key"], les types conditionnels et les template literal types ne sont pas évalués.
  • Un champ de classe initialisé avec un seul littéral (name = "kim", retries = 3) utilise cette valeur ; les autres initialiseurs comme new Date() ne servent qu'à indiquer le type.
  • Le code de schéma à l'exécution comme Zod ou io-ts n'est pas lu ; écrivez le type inféré par z.infer sous forme d'interface simple.
  • Map et Set sont affichés comme un objet et un tableau, mais JSON.stringify les transforme tous deux en {} : préférez Record ou des tableaux dans les types de réponse.

FAQ

Est-il normal que Date sorte en chaîne ?

Oui. JSON.stringify remplace une Date par le résultat de son toJSON(), une chaîne ISO 8601. Le côté récepteur reçoit donc bien une chaîne : typez-la string ou analysez-la.

Quelle valeur reçoit une union comme status: "active" | "inactive" ?

Le premier littéral dans l'ordre de déclaration, "active". Réordonnez l'union si vous préférez afficher une autre valeur.

Est-ce que ça marche avec les classes DTO de NestJS ?

Les déclarations de classes et les décorateurs sont analysés : les DTO annotés avec des décorateurs class-validator se convertissent bien, et les champs @Exclude() de class-transformer sont omis.

Comment passer du JSON aux types TypeScript ?

Utilisez la page JSON → TypeScript pour le sens inverse. Des pages séparées génèrent aussi du JSON à partir de modèles TypeORM, Sequelize et Mongoose.