Wie werden optionale Eigenschaften (prop?: string) abgebildet?

In TypeScript sind Felder mit Fragezeichen optional. In JSON Schema sind Eigenschaften standardmäßig optional, sofern sie nicht im Array 'required' aufgeführt sind. Bei aktiviertem strictNullChecks wird 'prop?: string' aus 'required' ausgeschlossen, während 'prop: string | null' in 'required' verbleibt, aber den Typ ['string', 'null'] erhält.

Welche JSDoc-Tags werden in JSON-Schema-Validierungsregeln übersetzt?

Allgemeine JSDoc-Beschreibungen werden in das Schlüsselwort 'description' übernommen. Spezifische Tags wie @minimum, @maximum, @minLength, @maxLength, @pattern, @format (z. B. email, uri, date-time, uuid), @default und @deprecated werden direkt in Validierungs-Constraints übersetzt.

Was ist der fundamentale Unterschied zwischen Draft-07 und Draft 2020-12?

Draft-07 verwendet 'definitions' für wiederverwendbare Schemas und Arrays für Tupel ('items'). Draft 2020-12 verwendet '$defs', führt 'prefixItems' für Tupel ein und ist vollständig kompatibel mit modernen Standards wie OpenAPI 3.1.

Können mehrere Schnittstellen aus einer einzigen Datei generiert werden?

Ja. Durch die Angabe des Haupt-Interface-Namens werden alle referenzierten Typen und verschachtelten Interfaces modular unter '$defs' oder 'definitions' extrahiert und über relative $ref-URIs verknüpft.

TypeScript-Schema-Compiler

TypeScript Interface zu JSON Schema Generator (Draft-07 & 2020-12)

Konvertieren Sie TypeScript-Interfaces, Type-Aliase und JSDoc-Kommentare nahtlos in standardkonforme JSON-Schema-Definitionen für API-Verträge und Formular-Validierungen.

Draft-07 & 2020-12 Konformität

Null Serverübertragung

Voreinstellungen:

Draft Version:

Root-Typ:

Definitionen-Schlüssel:

Zusätzliche Eigenschaften:

Formate automatisch erkennenJSDoc Annotationen parsen

Einrückung:

TypeScript Interfaces & Types0 Typen

/**
 * 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 Zeilen•1435 Zeichen•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 Definitionen•0 Eigenschaften

0.1 KB Gültig

Interfaces & Typen

0AST analysiert

JSON Schema Version

Draft 2020-12$defs

Eigenschaften & Regeln

0Regeln synthetisiert

100% Client-Side AST-Parsing

TypeScript-Syntaxanalyse und Schemagenerierung laufen vollständig lokal in Ihrer Browser-Sandbox ohne Serverübertragung.

Draft-07 & 2020-12 Konformität

Vollständige Unterstützung für $defs/definitions, Tupel-prefixItems, strikte Typisierung und Enums nach JSON-Schema-Standard.

JSDoc & Intelligente Einschränkungen

Extrahiert @description, @minimum, @maximum, @format, @pattern und @default direkt aus Kommentaren für OpenAPI-fähige Schemas.

TypeScript Interface zu JSON Schema Generator (Draft-07 & 2020-12)

100% Client-Side AST-Parsing

Draft-07 & 2020-12 Konformität

JSDoc & Intelligente Einschränkungen

TypeScript-Interface zu JSON Schema Generator (Draft-07 & 2020-12) — Referenz-Leitfaden

Wichtige Parameter & Steuerelemente

Profi-Tipps & Best Practices

Nutzen Sie Standard-JSDoc-Tags wie

Draft-07 speichert wiederverwendbare

Union-Types vs. Diskriminierte Unions

Häufige Fallstricke & Fehlerbehebung

Rekursive Schnittstellen und zirkuläre Typ-Referenzen

Komplexe Utility-Types (Omit, Pick, Mapped Types) werden leer exportiert

Häufig gestellte Fragen (FAQ)

Verwandte Werkzeuge & Dienstprogramme