So nutzt du: JSON Schema zu TypeScript
- Füge links dein JSON Schema ein — oder ein OpenAPI-Objekt
components.schemas. - Lege den Namen des Root-Typs fest und ob du
interfaceodertypeverwenden willst. - Die TypeScript-Typen aktualisieren sich beim Tippen; Definitionen unter
$defsoderdefinitionswerden zu eigenen benannten Typen. - Kopiere den Code in eine
.ts- oder.d.ts-Datei.
Wie JSON Schema auf TypeScript abgebildet wird
| JSON Schema | TypeScript |
|---|---|
"type": "string" / number, integer / boolean / null | string / number / boolean / null |
properties + required | Interface mit prop und optionalem prop? |
enum, const | Literal-Union: "draft" | "published" |
items, prefixItems | T[], Tupel [A, B] |
additionalProperties (Schema) | Index-Signatur [key: string]: T |
oneOf / anyOf / allOf | A | B / A | B / A & B |
$ref: "#/$defs/User" | der benannte Typ User |
"type": ["string", "null"] | string | null |
Rein validierende Schlüsselwörter wie minLength, pattern oder format haben kein TypeScript-Äquivalent; bei aktiviertem JSDoc werden sie in den Kommentar übernommen. Externe $ref-URLs werden als unknown typisiert.
Willst du lieber von Beispieldaten statt von einem Schema ausgehen? Nutze JSON to TypeScript. Um Daten gegen ein Schema zu prüfen, nutze den JSON Schema Validator.
Auch gesucht als: json schema to typescript, json schema in typescript umwandeln, json schema interface generieren, openapi schema zu typescript, json schema typen, json schema converter, typescript interface aus json schema.
Passende Tools zu: JSON Schema zu TypeScript
- JSON zu JSON Schema — Füge ein oder mehrere JSON-Beispiele ein und erhalte ein JSON Schema, das sie beschreibt: verschachtelte Objekte, Arrays von Objekten, die zu einem Item-Schema zusammengeführt werden, Pflichtfelder (Schlüssel, die in jedem Beispiel vorkommen), erkannte Formate wie E-Mail, date-time, URI und UUID, optionale Enums sowie die Ausgabe als 2020-12 oder draft-07.
- JSON zu Typen — Füge eine API-Antwort ein und erhalte gebrauchsfertige Modelle in 8 Sprachen: TypeScript, Python (dataclass, TypedDict oder Pydantic), Go, Java, C#, Kotlin, Swift und Rust.
- JSON Formatierer — Füge JSON ein, um es zu formatieren, zu minifizieren oder zu prüfen.
- OpenAPI-Validator — Füge eine API-Spezifikation ein, um sie gegen das offizielle OpenAPI-Schema zu prüfen, defekte Referenzen und inkonsistente Pfadparameter zu finden und alle Endpunkte auf einen Blick zu sehen.