SQLAlchemy-Modelle in JSON umwandeln!

Gib SQLAlchemy-Modelle ein, um Beispiel-JSON zu erzeugen! Unterstützt SQLAlchemy ORM. Praktisch für API-Dokumentation und Test-Request-Bodys (mock request body).
SQLAlchemy
Ergebnis
 

SQLAlchemy-Modelle in JSON umwandeln!

Füge SQLAlchemy-Modellklassen ein und erhalte Beispiel-JSON, dessen Keys die Namen der Spaltenattribute sind. Gelesen werden Mapped[...] mit mapped_column() im 2.0-Stil, Column() im 1.x-Stil und db.Column() von Flask-SQLAlchemy, und Spalten aus Mixins und Elternklassen werden zusammengeführt.

SQLAlchemy-Modelle lassen sich nicht direkt an json.dumps übergeben, daher ergänzen FastAPI- und Flask-Apps Pydantic- oder Marshmallow-Schemas. Nutze das hier, um festzulegen, welche Felder ein Modell ausliefert, bevor du dieses Schema schreibst, oder um Request-Bodies für Tests zu bauen.

So funktioniert es

  1. Füge die Modelldatei in das Feld SQLAlchemy ein. Lass Base, Mixins und enum.Enum-Klassen in derselben Eingabe, damit geerbte Spalten und Enum-Werte aufgelöst werden.
  2. Nur Klassen mit __tablename__ zählen als Modelle. Mehrere Modelle werden nach Klassennamen ausgegeben, etwa { "User": {...}, "Team": {...} }.
  3. Kopiere das Ergebnis.

Beispiel

Eingabe (Python · Flask-SQLAlchemy)
class TimestampMixin:
    created_at = db.Column(db.DateTime, default=datetime.utcnow)


class Plan(enum.Enum):
    FREE = "free"
    PRO = "pro"


class Subscription(TimestampMixin, db.Model):
    __tablename__ = "subscriptions"

    id = db.Column(db.Integer, primary_key=True)
    plan = db.Column(db.Enum(Plan), nullable=False)
    seats = db.Column(db.SmallInteger, default=1)
    trial_ends = db.Column(db.Date)
    user_id = db.Column(db.Integer, db.ForeignKey("users.id"))
    user = db.relationship("User", backref="subscriptions")
Ausgabe (JSON)
{
  "created_at": "1970-01-01T00:00:00",
  "id": 0,
  "plan": "free",
  "seats": 1,
  "trial_ends": "1970-01-01",
  "user_id": 0
}

created_at aus TimestampMixin steht der Vererbungsreihenfolge entsprechend vorne, und user fällt weg, weil relationship() keine Spalte ist. db.Enum(Plan) nimmt den ersten Wert des Enums, "free", und db.Date wird zu 1970-01-01. seats zeigt 1 aus default=1, während created_at den Platzhalter behält, weil datetime.utcnow eine Funktion ist.

Unterstützte Funktionen

  • Python-Type-Hints wie Mapped[int], Mapped[Optional[str]] und Mapped[str | None] bestimmen den Wert.
  • Ohne Type Hint entscheidet das SQL-Typargument, wie in Column(String(50)) oder db.Column(db.Numeric).
  • DateTime → 1970-01-01T00:00:00, Date → 1970-01-01, Time → 00:00:00, JSON/JSONB → {}, Uuid → eine UUID aus lauter Nullen.
  • ARRAY(String) und Mapped[list[str]] werden zu Arrays mit einem Element.
  • Eine Klasse, die enum.Enum erweitert und über Enum(Plan) oder Mapped[Plan] verwendet wird, liefert den Wert ihres ersten Members.
  • relationship(), column_property(), einfache Klassenvariablen und Dunder-Attribute wie __table_args__ werden ausgeschlossen.
  • Spalten aus Mixins und Elternmodellen stehen vor den eigenen Spalten der Kindklasse.

Anwendungsfälle

Ein Pydantic-Response-Modell entwerfen

Bevor du die Pydantic-Klasse für response_model von FastAPI schreibst, prüfe die Felder und Typen, die das Modell als JSON ausliefert. Gib dieses JSON in die Seite JSON zu Python, um zusätzlich einen Pydantic-Entwurf zu bekommen.

Test-Payloads für eine Flask-API

Baue den Body für client.post("/subscriptions", json=...) mit Keys, die zu den Attributen des Modells passen. Entferne vorher die automatisch hochgezählte id und den Erstellungszeitpunkt.

Hinweise und Einschränkungen

  • Ein literales default= ("new", 1, True, None) dient als Beispielwert; Callables wie datetime.utcnow oder dict werden nicht ausgeführt. server_default= und nullable= werden nicht gelesen.
  • Bekommt eine Spalte einen eigenen Datenbanknamen, wie in Column("user_name", String), bleibt der JSON-Key trotzdem der Name des Python-Attributs.
  • Über relationship geladene verwandte Objekte sind nicht enthalten. Ergänze verschachtelte Objekte selbst, wenn deine Antwort sie einbettet.
  • Berechnete Attribute wie hybrid_property oder @property sind nicht Teil der Ausgabe.

Häufige Fragen

Warum ist Mapped[Optional[str]] ein leerer String statt null?

Optional bedeutet, dass None erlaubt ist; das Beispiel zeigt den Fall, in dem ein Wert vorhanden ist, und verwendet daher das innere str. Ändere es in der Ausgabe auf null, wenn du diesen Fall brauchst.

Warum haben Datum-Uhrzeit-Werte kein Z und keinen Offset?

DateTime-Spalten sind standardmäßig naiv, und isoformat() gibt sie ohne Offset aus. Verwendest du DateTime(timezone=True), liegt ein Beispiel mit +00:00 näher an dem, was du tatsächlich siehst.

Kann es Django-Modelle umwandeln?

Nein. Diese Seite versteht nur die SQLAlchemy-Syntax mit Column, mapped_column und Mapped; Django-Felder wie models.CharField werden nicht erkannt.