TypeScript → JSON-Schema-Generator

TypeScript-Code Eingabe

Editor wird geladen…

JSON Schema Ausgabe

Einstellungen

Wählen Sie, welches Interface/Type als JSON-Schema-Root behandelt werden soll.

Das Parsing läuft vollständig im Browser. Ihr Code verlässt die Seite nicht.

Fügen Sie Ihre TypeScript-Typen ein, um sofort JSON Schema zu erzeugen.

Unterstützt Interfaces, type aliases, public class fields, optional/readonly und union types.

So konvertieren Sie TypeScript-Interfaces, Types und Klassen zu JSON Schema – Schritt-für-Schritt

Dieser Online-Konverter (TypeScript → JSON Schema) hilft Ihnen, JSON Schema aus echten Modellen (DTOs, structs, classes) zu generieren, um Payloads zu validieren, Verträge zu teilen und Mock JSON zu erzeugen.

  1. Schritt 1 – TypeScript-Quelle einfügen

    • Fügen Sie die Modelle, die Sie dokumentieren möchten, in den linken Editor ein.
    • Fügen Sie referenzierte Typen im selben Snippet hinzu, damit definitions generiert werden können.
    • Mit Beispiel laden Sie ein Beispiel und sehen das erwartete Eingabeformat.
  2. Schritt 2 – Root-Typ auswählen (falls nötig)

    • Wenn mehrere Definitions erkannt werden, wählen Sie die Root-Definition, die zu Ihrem API-Payload passt.
    • Das Output-Schema wird um die gewählte Root-Definition aufgebaut und kann zusätzliche Definitions enthalten.
  3. Schritt 3 – JSON-Schema-Ausgabe prüfen

    • Prüfen Sie Typen, required vs. optionale Felder und verschachtelte Objekt-/Array-Strukturen.
    • Achten Sie auf definitions und $ref wenn Modelle andere Modelle referenzieren.
    • Schema kopieren oder herunterladen – für Validierung, Dokumentation oder schema-first Entwicklung.
  4. Schritt 4 – Validieren oder Mock JSON generieren

    • Klicken Sie auf Mock-Daten generieren um den Mock-Generator mit vorbefülltem Schema zu öffnen.
    • Validieren Sie reale Payloads gegen Ihr Schema, um Breaking Changes früh zu erkennen.
    • Wenn Sie fortgeschrittene Komposition nutzen (z. B. anyOf/oneOf/allOf), prüfen Sie das Ergebnis mit einem vollständigen Validator wie Ajv.

Hinweis zum Keyword-Support

Generierte Schemas können $ref enthalten und bei Bedarf um anyOf, oneOf, oder allOfergänzt werden. Für komplexe Schemas nutzen Sie einen vollständigen JSON-Schema-Validator und dereference vor der Mock-Generierung, falls nötig.

Verwandte JSON-Schema- und Code-Generierungs-Tools

Nutzen Sie diese Tools, um Schemas zu validieren, Mock-Payloads zu erzeugen, JSON-Beispiele zu formatieren und Code und Verträge synchron zu halten.

Häufig gestellte Fragen

Welche TypeScript-Syntax wird unterstützt?

Interfaces, type aliases und Klassen mit public fields. Optional properties, readonly, string-literal keys, union types, Arrays, Record und verschachtelte Referenzen werden unterstützt. Kommentare und Decorators werden ignoriert, sodass Sie DTOs direkt aus dem Projekt einfügen können.

Wie funktioniert das Type-Mapping?

Primitive Typen (string, number, boolean, bigint, Date) werden auf JSON-Schema-Primitives mit passenden formats gemappt. Arrays (Foo[]/Array<Foo>), Record<string, T> und Dictionary-Shapes werden zu Arrays/Objects. Union types mit null/undefined markieren das Feld als optional.

Kann ich das auch für Klassen nutzen?

Ja. Solange die Klasse public fields (oder readonly properties) mit Typ-Annotationen hat, wird sie in JSON Schema konvertiert. Alles läuft im Browser – kein Code verlässt Ihr Gerät.

Wie bekomme ich Mock JSON aus dem Schema?

Nach der Schema-Generierung klicken Sie auf "Mock-Daten generieren", um den Mock-Generator mit vorbefülltem Schema zu öffnen. Locale, Array-Größen und optionale Felder lassen sich konfigurieren.

TypeScript → JSON-Schema-Generator | JSONSwiss