I-convert ang mga Python class sa JSON!

I-paste ang Python (Pydantic·dataclass) na code at kumuha ng halimbawang JSON! Sinusuportahan ang Pydantic BaseModel, Field(alias), dataclass, TypedDict. Magagamit sa API docs at test request body (mock request body).
Python
Resulta
 

I-convert ang mga Python class sa JSON!

I-paste ang mga Python model na isinulat gamit ang Pydantic BaseModel, @dataclass o TypedDict, at makakakuha ka ng halimbawang JSON document na sumusunod sa istruktura nila. Binabasa ang Field(alias=...) at ang config na alias_generator=to_camel, kaya makikita mo ang mga key na talagang kinalalabasan ng mga snake_case na field mo kapag na-serialize.

Bagay ito sa paggawa ng mga request example para sa mga FastAPI endpoint, sa pagbabahagi ng webhook o queue payload schema sa ibang team, o sa paghahanda ng mga JSON fixture para sa pytest.

Paano gamitin

  1. I-paste ang laman ng .py file na may hawak ng mga model mo. Nilalaktawan ang mga linyang import, mga method at mga decorator gaya ng @field_validator.
  2. Isama ang mga nire-reference na sub-model at Enum class para mapunan ang mga bahaging iyon. Naiintindihan ang mga string forward reference ("Order").
  3. Kapag Awtomatiko, pinipili ng Root type ang class na hindi ginagamit bilang field type ng ibang model; puwede ka ring pumili mula sa listahan.
  4. Kopyahin ang JSON papunta sa examples ng json_schema_extra, isang test data file o sa API docs mo.

Halimbawa

Input (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)
Output (JSON)
{
  "eventType": "payment.succeeded",
  "amount": "0",
  "currency": "KRW",
  "payer": {
    "customerId": "",
    "emailAddress": ""
  },
  "receiptUrl": "",
  "retries": 0
}

Dahil sa to_camel sa model_config, nagiging camelCase na key ang event_type, receipt_url at customer_id, habang nananaig ang explicit na alias="retries" para sa retry_count. May Field(exclude=True) ang raw_payload at hindi ito isinasama. Kinukuha ng Literal ang una nitong value, payment.succeeded, at napapanatili nang ganoon lang ang literal na default na "KRW".

Mga sinusuportahang feature

  • Binabasa ang Pydantic BaseModel (v1 at v2), @dataclass, TypedDict, at Enum/StrEnum/IntEnum kasama ang auto().
  • Mga key name mula sa Field(alias=...), serialization_alias, at alias_generator (to_camel, to_pascal) na naka-set sa model_config = ConfigDict(...) o sa isang inner na class Config:.
  • Hindi kasama: mga pangalang nagsisimula sa _, ClassVar, model_config, at mga field na may Field(exclude=True).
  • Paghawak sa type: Optional[X] / X | None → sample ng X, Literal[...] → unang value, Annotated/Required/NotRequired → inner type, list/set/tuple → array na may isang element, dict[str, V] → {"key": V}.
  • Mga Pydantic type: EmailStr, HttpUrl, SecretStr, constr → string; conint, PositiveInt → 0; Decimal at condecimal → ang string na "0", gaya ng pagsulat sa kanila ng Pydantic v2 JSON.
  • Mga petsa at oras: datetime → 1970-01-01T00:00:00, date → 1970-01-01, time → 00:00:00, timedelta → PT0S; may maayos na anyong value ang UUID.
  • Ginagamit bilang sample ang mga default na string, number at True/False literal; nagiging value ng member na iyon ang enum default gaya ng Status.PAID.

Mga gamit

Mga FastAPI request example

Gumawa ng JSON mula sa isang request model at ilagay ito sa model_config = {"json_schema_extra": {"examples": [...]}}; ang example sa /docs ay gagamit na ng parehong mga alias key na inaasahan ng endpoint.

Pagbabahagi ng mga webhook at event payload

Kung naka-define sa Pydantic ang mga payload ng Celery task o Kafka message, ibigay sa mga consumer team sa Node o Go ang resultang JSON sa halip na Python code para magkasundo sa istruktura.

Paghahanda ng mga pytest fixture

Gawin ang skeleton ng isang JSON file para sa model_validate_json() o mga API client test, saka palitan ang mga indibidwal na value para magdagdag ng mga edge case.

Mga paalala at limitasyon

  • Nakakakuha pa rin ng typed na sample sa halip na null ang mga Optional na field at mga field na None ang default.
  • Pinupunan ang Decimal bilang string na "0", tugma sa JSON serialization ng Pydantic v2 (model_dump_json). Kung numero ang inilalabas ng project mo (Pydantic v1, o json.dumps(default=float)), palitan ito ng numero.
  • Hindi pinapatakbo ang code na nagbabago ng hugis ng output, gaya ng @computed_field, @field_serializer o @model_serializer.
  • Ginagamit ng Union[A, B] ang unang member na hindi None; hindi mino-model ang mga discriminated union na pinipili gamit ang isang discriminator field.
  • Hindi pinapatakbo ang default_factory at mga default na galing sa function call; galing sa type ang value.

Mga madalas itanong

Mga alias key ang gamit ng output, pero mga field name ang inilalabas ng model_dump_json() ko.

Nagse-serialize ang Pydantic ayon sa field name maliban kung ipapasa mo ang by_alias=True. Gumagamit ang response_model ng FastAPI ng by_alias=True bilang default, na tugma sa output ng tool na ito. Kapag ikaw mismo ang magda-dump, tawagin ang model_dump_json(by_alias=True).

Walang alias ang mga dataclass. Puwede pa rin bang iba ang mga key sa mga field name?

Walang pagpapalit ng pangalan ang standard na dataclass, kaya ang field name ang key. Kung may comment sa dulo ang isang field na # JSON: "orderId", gaya ng sa mga dataclass na ginawa ng page na JSON → Python ng site na ito, ang pangalang iyon ang ginagamit.

Kasama ba ang mga NotRequired na key ng isang TypedDict?

Oo. Layunin ng sample na ipakita ang bawat posibleng key, kaya kasama ang mga field na NotRequired at total=False. Markahan sa docs mo ang mga puwedeng hindi isama.

Kaya ba nito ang mga SQLAlchemy model?

Para sa mga model na batay sa type hint ang page na ito. Para sa mga SQLAlchemy model na dine-declare gamit ang Column(...) o Mapped[...], gamitin ang page na SQLAlchemy → JSON.