Wandle Python-Klassen in JSON um!

Füge Python-Code (Pydantic·dataclass) ein und erhalte ein Beispiel-JSON! Unterstützt Pydantic BaseModel, Field(alias), dataclass, TypedDict. Praktisch für API-Dokumentation und Test-Request-Bodys (mock request body).
Python
Ergebnis
 

Wandle Python-Klassen in JSON um!

Füge Python-Modelle ein, die mit Pydantic BaseModel, @dataclass oder TypedDict geschrieben sind, und erhalte ein Beispiel-JSON-Dokument, das ihrer Struktur folgt. Field(alias=...) und eine Konfiguration mit alias_generator=to_camel werden gelesen, du siehst also die Keys, zu denen deine snake_case-Felder tatsächlich serialisiert werden.

Das passt zum Erstellen von Request-Beispielen für FastAPI-Endpoints, zum Teilen eines Webhook- oder Queue-Payload-Schemas mit einem anderen Team oder zum Vorbereiten von JSON-Fixtures für pytest.

So funktioniert es

  1. Füge den Inhalt der .py-Datei mit deinen Modellen ein. import-Zeilen, Methoden und Decorators wie @field_validator werden übersprungen.
  2. Nimm referenzierte Untermodelle und Enum-Klassen mit auf, damit diese Teile befüllt werden. Forward-Referenzen als String ("Order") werden verstanden.
  3. Bei Automatisch wählt Wurzeltyp die Klasse, die von keinem anderen Modell als Feldtyp verwendet wird; du kannst auch eine aus der Liste wählen.
  4. Kopiere das JSON in examples von json_schema_extra, eine Testdatendatei oder deine API-Doku.

Beispiel

Eingabe (Python · Pydantic)
class Payer(BaseModel):
    model_config = ConfigDict(alias_generator=to_camel)
    customer_id: str
    email_address: str

class PaymentEvent(BaseModel):
    model_config = ConfigDict(alias_generator=to_camel)
    event_type: Literal["payment.succeeded", "payment.failed"]
    amount: Decimal
    currency: str = "KRW"
    payer: Payer
    receipt_url: Optional[str] = None
    retry_count: int = Field(default=0, alias="retries")
    raw_payload: dict = Field(exclude=True)
Ausgabe (JSON)
{
  "eventType": "payment.succeeded",
  "amount": "0",
  "currency": "KRW",
  "payer": {
    "customerId": "",
    "emailAddress": ""
  },
  "receiptUrl": "",
  "retries": 0
}

Wegen to_camel in model_config werden event_type, receipt_url und customer_id zu camelCase-Keys, während bei retry_count das explizite alias="retries" gewinnt. raw_payload hat Field(exclude=True) und wird weggelassen. Das Literal nimmt seinen ersten Wert, payment.succeeded, und der literale Standardwert "KRW" bleibt unverändert.

Unterstützte Funktionen

  • Liest Pydantic BaseModel (v1 und v2), @dataclass, TypedDict sowie Enum/StrEnum/IntEnum einschließlich auto().
  • Key-Namen aus Field(alias=...), serialization_alias und alias_generator (to_camel, to_pascal), gesetzt in model_config = ConfigDict(...) oder einer inneren class Config:.
  • Ausgeschlossen: Namen, die mit _ beginnen, ClassVar, model_config und Felder mit Field(exclude=True).
  • Typbehandlung: Optional[X] / X | None → Beispiel von X, Literal[...] → erster Wert, Annotated/Required/NotRequired → innerer Typ, list/set/tuple → Array mit einem Element, dict[str, V] → {"key": V}.
  • Pydantic-Typen: EmailStr, HttpUrl, SecretStr, constr → String; conint, PositiveInt → 0; Decimal und condecimal → der String "0", so wie Pydantic v2 sie in JSON schreibt.
  • Datum und Uhrzeit: datetime → 1970-01-01T00:00:00, date → 1970-01-01, time → 00:00:00, timedelta → PT0S; UUID bekommt einen wohlgeformten Wert.
  • Literale Standardwerte für Strings, Zahlen und True/False dienen als Beispiele; ein Enum-Standardwert wie Status.PAID wird zum Wert dieses Members.

Anwendungsfälle

Request-Beispiele für FastAPI

Erzeuge JSON aus einem Request-Modell und setze es in model_config = {"json_schema_extra": {"examples": [...]}} ein; das Beispiel unter /docs verwendet dann dieselben Alias-Keys, die der Endpoint erwartet.

Webhook- und Event-Payloads teilen

Sind die Payloads von Celery-Tasks oder Kafka-Nachrichten in Pydantic definiert, gib konsumierenden Teams mit Node oder Go das resultierende JSON statt Python-Code, um euch auf die Struktur zu einigen.

pytest-Fixtures vorbereiten

Erstelle das Gerüst einer JSON-Datei für model_validate_json() oder API-Client-Tests und ändere dann einzelne Werte, um Grenzfälle hinzuzufügen.

Hinweise und Einschränkungen

  • Optional-Felder und Felder mit Standardwert None bekommen trotzdem ein typisiertes Beispiel statt null.
  • Decimal wird als String "0" befüllt, passend zur JSON-Serialisierung von Pydantic v2 (model_dump_json). Gibt dein Projekt stattdessen Zahlen aus (Pydantic v1 oder json.dumps(default=float)), ändere es in eine Zahl.
  • Code, der die Ausgabe umformt, etwa @computed_field, @field_serializer oder @model_serializer, wird nicht ausgeführt.
  • Union[A, B] verwendet das erste Member, das nicht None ist; über ein discriminator-Feld ausgewählte Discriminated Unions werden nicht abgebildet.
  • default_factory und durch Funktionsaufrufe erzeugte Standardwerte werden nicht ausgeführt; der Wert ergibt sich aus dem Typ.

Häufige Fragen

Die Ausgabe verwendet Alias-Keys, mein model_dump_json() gibt aber Feldnamen aus.

Pydantic serialisiert nach Feldnamen, sofern du nicht by_alias=True übergibst. response_model von FastAPI verwendet standardmäßig by_alias=True, was zur Ausgabe dieses Tools passt. Wenn du selbst dumpst, rufe model_dump_json(by_alias=True) auf.

Dataclasses haben keine Aliase. Können Keys trotzdem von Feldnamen abweichen?

Die Standard-dataclass kennt kein Umbenennen, der Feldname ist also der Key. Trägt ein Feld einen nachgestellten Kommentar # JSON: "orderId", wie in Dataclasses von der Seite JSON → Python dieser Website, wird dieser Name verwendet.

Werden NotRequired-Keys eines TypedDict aufgenommen?

Ja. Das Beispiel soll jeden möglichen Key zeigen, daher werden NotRequired- und total=False-Felder aufgenommen. Markiere in deiner Doku, welche davon fehlen dürfen.

Verarbeitet es SQLAlchemy-Modelle?

Diese Seite ist für Modelle auf Basis von Type Hints gedacht. Für SQLAlchemy-Modelle, die mit Column(...) oder Mapped[...] deklariert sind, nimm die Seite SQLAlchemy → JSON.