Was ist ein TypeScript-zu-JSON-Schema-Konverter?
Dieses Tool konvertiert TypeScript-Schnittstellen in das JSON-Schema-Format. JSON-Schema ist ein Vokabular zur Annotation und Validierung von JSON-Daten, das weit verbreitet ist für API-Dokumentation, Formularvalidierung und Konfigurationsdatei-Validierung. Durch die Konvertierung Ihrer TypeScript-Typen erhalten Sie ein Schema, das mit Validatoren, API-Gateways und Dokumentationstools verwendet werden kann.
Wie Sie diesen Konverter verwenden
- Fügen Sie eine TypeScript-Interface-Definition im Eingabefeld ein.
- Klicken Sie auf „In JSON-Schema konvertieren", um das Schema zu generieren.
- Kopieren Sie das JSON-Schema-Ausgabe für die Verwendung in Ihrem Projekt.
Unterstützte TypeScript-Typen
Dieses Tool unterstützt grundlegende TypeScript-Typen: string, number, boolean, any, optionale Eigenschaften (?) und Arrays (type[] oder Array<type>). Es erkennt auch null und Union-Typen mit null (z.B. string | null).
Häufig gestellte Fragen
Verarbeitet dies verschachtelte Schnittstellen?
Dieses Tool analysiert jeweils eine Schnittstelle mit flachen Eigenschaftstypen. Für verschachtelte Objekte definieren Sie diese als separate Schnittstellen und kombinieren Sie die Schemas manuell, oder verwenden Sie Inline-Objekttypen innerhalb der Schnittstelle.
Welche JSON-Schema-Version wird generiert?
Die Ausgabe folgt JSON Schema Draft-07 (http://json-schema.org/draft-07/schema#), die am weitesten verbreitete Version über Validatoren und Tools.