Comment le générateur gère-t-il les champs optionnels (prop?: string) ?

En TypeScript, le point d'interrogation indique une propriété facultative. En JSON Schema, les propriétés sont facultatives par défaut, sauf si elles apparaissent dans le tableau 'required'. Avec strictNullChecks, 'prop?: string' est exclu de 'required', tandis que 'prop: string | null' reste dans 'required' avec un type ['string', 'null'].

Quelles balises JSDoc sont converties en règles de validation JSON Schema ?

Le texte explicatif alimente le mot-clé 'description'. Les balises telles que @minimum, @maximum, @minLength, @maxLength, @pattern, @format (email, uri, date-time, uuid), @default et @deprecated sont converties en contraintes de validation natives.

Quelles sont les distinctions majeures entre Draft-07 et Draft 2020-12 ?

Draft-07 emploie 'definitions' et valide les tuples à l'aide d'un tableau dans 'items'. Draft 2020-12 standardise '$defs', introduit 'prefixItems' pour les tuples et s'intègre harmonieusement avec OpenAPI 3.1.

Peut-on convertir plusieurs interfaces issues d'un même fichier TypeScript ?

Oui. En sélectionnant l'interface racine principale, tous les sous-types, énumérations et interfaces référencées sont générés de manière modulaire dans '$defs' ou 'definitions', reliés par des URIs relatives $ref.

Compilateur de schéma TypeScript

Générateur de JSON Schema depuis TypeScript Interface (Draft-07 & 2020-12)

Transformez vos interfaces TypeScript, alias de types et commentaires JSDoc en définitions JSON Schema standard pour vos contrats d'API et validateurs de formulaires.

Conformité Draft-07 & 2020-12

Zéro transmission au serveur

Préréglages :

Version du Draft:

Type Racine:

Clé de Définitions:

Propriétés Additionnelles:

Inférence Intelligente de FormatsAnalyser JSDoc

Indentation:

Interfaces & Types TypeScript0 Types

/**
 * Core User Profile entity for enterprise authentication and RBAC
 * @title UserProfile
 * @description Primary identity record representing an authenticated user account
 */
UserProfile {
  /**
   * Primary system UUID v4 identifier
   * @format uuid
   */
  id: string;

/**
   * Validated primary email address
   * @format email
   */
  email: string;

/**
   * Unique handle or display username
   * @minLength 3
   * @maxLength 30
   * @pattern ^[a-zA-Z0-9_-]+$
   */
  username: string;

/**
   * Age in completed calendar years
   * @minimum 18
   * @maximum 120
   */
  age?: number;

/**
   * Account activation status
   * @default true
   */
  isActive: boolean;

/**
   * Access control security role
   */
  role: 'admin' | 'editor' | 'subscriber' | 'guest';

/**
   * Primary mailing and billing address
   */
  address: Address;

/**
   * Granted OAuth 2.0 permission scopes
   */
  permissions: string[];

/**
   * Account creation ISO-8601 timestamp
   * @format date-time
   */
  createdAt: string;

/**
   * Arbitrary key-value metadata tags
   */
  metadata?: Record<string, string>;
}

/**
 * Standardized postal and geolocation address definition
 * @title Address
 */
Address {
  street: string;
  suite?: string;
  city: string;
  state: string;
  /**
   * Postal or ZIP code
   * @pattern ^[0-9]{5}(?:-[0-9]{4})?$
   */
  postalCode: string;
  country: string;
  isPrimary?: boolean;
}

84 Lignes•1435 Caractères•1.4 KB (Octets)

TypeScript AST Ready

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "title": "EmptySchema",
  "type": "object",
  "properties": {}
}

2020-12 ($defs)•0 Définitions•0 Propriétés

0.1 Ko valide

Interfaces & Types

0AST analysé

Version JSON Schema

Draft 2020-12$defs

Propriétés & Règles

0règles synthétisées

100% Analyse AST Côté Client

L'analyse syntaxique TypeScript et la génération JSON Schema s'exécutent entièrement dans votre navigateur sans aucun envoi serveur.

Conformité Draft-07 & 2020-12

Compatibilité totale avec les spécifications JSON Schema, incluant $defs/definitions, les tuples prefixItems et les enums.

Inférence JSDoc & Contraintes Avancées

Extrait directement @description, @minimum, @maximum, @format, @pattern et @default des commentaires pour des schémas de niveau OpenAPI.

Générateur de JSON Schema depuis TypeScript Interface (Draft-07 & 2020-12)

100% Analyse AST Côté Client

Conformité Draft-07 & 2020-12

Inférence JSDoc & Contraintes Avancées

Guide Développeur : Générateur de TypeScript Interface vers JSON Schema (Draft-07 & 2020-12) — Guide de référence

Paramètres clés et contrôles

Conseils de pro et bonnes practices

Intégrez des balises JSDoc telles que

Draft-07 stocke les sous-types

Les types union simples

Pièges courants et dépannage

Gestion des types récursifs et dépendances circulaires

Types utilitaires complexes (Omit, Pick, Partial) produisant des schémas vides

Foire aux questions (FAQ)

Outils et utilitaires connexes