Dieses Beispiel zeigt, wie man TypeScript-Typen aus einer typischen REST API-Antwort erzeugt. Die vorausgefüllte JSON stellt ein Benutzerobjekt mit verschachtelter Adresse, einem Rollen-Array und einem Array von Beitrag-Objekten dar.
Was Sie Bekommen
Das Werkzeug erzeugt:
- Ein
Root-Interface mit allen übergeordneten Feldern typisiert - Ein
RootAddress-Interface für das verschachtelte Adressobjekt - Ein
RootPostsItem-Interface für jeden Beitrag im Array - Korrekte Typen:
stringfür Text,stringfür IDs und Zählungen,booleanfür Flags,string[]für String-Arrays
So Verwenden Sie Es
- Das Beispiel lädt mit einer Beispiel-API-Antwort, die bereits ausgefüllt ist
- Wechseln Sie zwischen den Ausgabemodi Interface und Type, um beide Stile zu sehen
- Kopieren Sie die erzeugten Typen und fügen Sie sie in Ihr TypeScript-Projekt ein
- Ersetzen Sie die Beispieldaten mit Ihrer tatsächlichen API-Antwort, um Typen für Ihren spezifischen Endpunkt zu erzeugen
Muster aus der Praxis
Die meisten REST APIen geben Objekte mit verschachtelten Strukturen und Arrays zurück. Dieses Beispiel deckt das gängige Muster ab: flache Felder auf oberster Ebene, ein verschachteltes Objekt für zugehörige Daten und Arrays für Sammlungen. Die erzeugten Typen geben Ihnen vollständige IntelliSense-Unterstützung bei der Arbeit mit API-Antworten in TypeScript.