Python-Dataclasses aus API-Antwort generieren
Dieses Beispiel erzeugt Python-Dataclasses mit Typannotationen aus einer typischen REST-API-Antwort. Die vorausgefüllte JSON repräsentiert ein Benutzerobjekt mit verschachtelter Adresse, einem Array von Rollen und einem Array von Beitrag-Objekten. Wechseln Sie zum Python-Modus, um die erzeugten Dataclasses zu sehen.
Was Sie Bekommen
Das Werkzeug erzeugt:
- Eine Root-
Root-Dataclass mit allen Feldern der obersten Ebene RootAddress-Dataclass für das verschachtelte AdressobjektRootPostsItem-Dataclass für Array-Elemente- snake_case-Feldnamen aus camelCase-JSON-Schlüsseln
Optional[T] = Nonefür fehlende Felder in einigen Array-Elementen- Python-Typzuordnungen:
str,int,float,bool,List[str],Dict[str, Any] - Korrekte Imports aus
dataclassesundtyping
So verwenden Sie es
- Das Beispiel lädt mit einer Beispiel-API-Antwort und dem vorausgewählten Python-Modus
- Untersuchen Sie die erzeugten Dataclasses und deren Typannotationen
- Kopieren Sie den Code und fügen Sie ihn in Ihr Python-Projekt ein
- Ersetzen Sie durch Ihre tatsächliche API-Antwort, um Dataclasses für Ihre Endpunkte zu erzeugen
Muster aus der Praxis
Python-Dataclasses mit Typannotationen sind der Standardweg, um strukturierte Daten in modernem Python zu modellieren. Der erzeugte Code funktioniert mit mypy für statische Typprüfung, pydantic für Validierung und dataclass_json für Serialisierung. Verwenden Sie Optional für Felder, die nicht immer in der Antwort vorhanden sind.