¿Cómo maneja el generador las propiedades opcionales (prop?: string)?

En TypeScript, una propiedad con '?' es opcional. En JSON Schema, los campos son opcionales a menos que figuren en la lista 'required'. Con strictNullChecks activo, 'prop?: string' se omite de 'required', mientras que 'prop: string | null' se mantiene en 'required' con un tipo ['string', 'null'].

¿Qué etiquetas JSDoc se convierten en reglas de validación de JSON Schema?

El texto descriptivo se traslada al atributo 'description'. Etiquetas como @minimum, @maximum, @minLength, @maxLength, @pattern, @format (email, uri, date-time, uuid), @default y @deprecated se convierten en restricciones nativas del esquema.

¿Cuáles son las diferencias clave entre Draft-07 y Draft 2020-12?

Draft-07 utiliza 'definitions' y valida tuplas mediante matrices en 'items'. Draft 2020-12 adopta '$defs', introduce 'prefixItems' para tuplas y se alinea con OpenAPI 3.1 y los estándares modernos de la web.

¿Se pueden exportar múltiples interfaces desde un mismo archivo TypeScript?

Sí. Al designar la interfaz principal o raíz, todos los tipos y subtipos referenciados se compilan de manera modular dentro de '$defs' o 'definitions', vinculados automáticamente mediante URIs relativas $ref.

Compilador de esquemas TypeScript

Generador de JSON Schema desde TypeScript Interface (Draft-07 y 2020-12)

Transforme interfaces, tipos de TypeScript y comentarios JSDoc en definiciones estándar de JSON Schema para contratos de API y generadores de formularios.

Conformidad con Draft-07 y 2020-12

Cero transmisión al servidor

Preajustes:

Versión de Draft:

Tipo Raíz:

Clave de Definiciones:

Propiedades Adicionales:

Inferir Formatos InteligentesAnalizar JSDoc

Indentación:

Interfaces y Tipos TypeScript0 Tipos

/**
 * 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 Líneas•1435 Caracteres•1.4 KB (Bytes)

TypeScript AST Ready

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

2020-12 ($defs)•0 Definiciones•0 Propiedades

0.1 KB Válido

Interfaces y Tipos

0AST analizado

Versión de JSON Schema

Draft 2020-12$defs

Propiedades y Reglas

0reglas sintetizadas

100% Procesamiento AST en Cliente

La extracción de tipos y la generación de esquemas se ejecutan localmente en el navegador. Cero telemetría o envío de datos al servidor.

Conformidad con Draft-07 y 2020-12

Soporte integral para $defs/definitions, tuplas prefixItems, tipado estricto y resolución de enumeraciones según el estándar.

Inferencia JSDoc y Restricciones

Extrae @description, @minimum, @maximum, @format, @pattern y @default directamente del código para esquemas aptos para OpenAPI.

Generador de JSON Schema desde TypeScript Interface (Draft-07 y 2020-12)

100% Procesamiento AST en Cliente

Conformidad con Draft-07 y 2020-12

Inferencia JSDoc y Restricciones

Guía de Desarrollo: Generador de TypeScript Interface a JSON Schema (Draft-07 & 2020-12) — Guía de referencia

Parámetros clave y controles

Consejos profesionales y mejores prácticas

Aproveche etiquetas JSDoc como

Draft-07 organiza las definiciones

Las uniones estándar

Errores comunes y solución de problemas

Referencias circulares y tipos recursivos

Tipos de utilidad complejos (Omit, Pick, tipos mapeados) generan esquemas vacíos

Preguntas frecuentes (FAQ)

Herramientas y utilidades relacionadas