Chuyển JSON thành Pydantic model Python!

Nhập JSON để tạo mã Pydantic model Python, kể cả các object lồng nhau! Hỗ trợ Pydantic v2 BaseModel, dataclass, FastAPI. SQLAlchemy ở các tab phía trên.
JSON
Kết quả
 

Chuyển JSON thành Pydantic model Python!

Công cụ này biến cấu trúc JSON thành class BaseModel của Pydantic v2 hoặc code @dataclass của thư viện chuẩn. Tên field được viết lại sang snake_case đúng phong cách Python, và mỗi object lồng nhau có class riêng.

Hãy dùng nó khi định nghĩa schema request và response cho FastAPI, khi thêm type hint cho dữ liệu lấy về bằng requests hay httpx, hoặc khi dọn lại script ETL và scraping đang đào sâu vào dict bằng key chuỗi.

Cách sử dụng

  1. Dán JSON bạn muốn mô hình hóa.
  2. Nhập tên model cấp cao nhất vào Tên kiểu (ví dụ Forecast).
  3. Ở mục Kiểu, chọn Pydantic (v2) nếu cần validation và alias, hoặc dataclass cho model không phụ thuộc thư viện nào.
  4. Sao chép kết quả vào một module như models.py. Kiểu và tên kiểu được lưu trong URL.

Ví dụ

Đầu vào (JSON)
{
  "city": "Seoul",
  "updatedAt": "2024-05-01T09:00:00+09:00",
  "current": { "temp": 18.5, "humidity": 40 },
  "hourly": [
    { "hour": 10, "temp": 19, "rain_mm": 0 },
    { "hour": 11, "temp": 20.5, "rain_mm": 0.4, "alert": "shower" }
  ]
}
Đầu ra (Python · Pydantic v2)
from __future__ import annotations

from pydantic import BaseModel, ConfigDict, Field


class Hourly(BaseModel):
    hour: int
    temp: float
    rain_mm: float
    alert: str | None = None


class Current(BaseModel):
    temp: float
    humidity: int


class Forecast(BaseModel):
    model_config = ConfigDict(populate_by_name=True)

    city: str
    updated_at: str = Field(alias="updatedAt")
    current: Current
    hourly: list[Hourly]

updatedAt thành field updated_at, gắn lại với key gốc bằng Field(alias="updatedAt"). Trong hourly, temp trộn số nguyên và số thập phân nên thành float, còn alert, chỉ có ở phần tử thứ hai, là str | None = None. Class con được xuất ra trước.

Tính năng hỗ trợ

  • Pydantic v2: field bị đổi tên dùng Field(alias=...), và model_config = ConfigDict(populate_by_name=True) cho phép điền giá trị bằng cả tên Python.
  • dataclass: field không có giá trị mặc định được đưa lên trước field = None để tránh TypeError: non-default argument follows default argument; key gốc được giữ dưới dạng comment # JSON: "updatedAt".
  • Kiểu: str, int, float, bool, list[...], và Any cho giá trị có kiểu lẫn lộn.
  • Field thiếu ở một số phần tử hoặc chứa null thành X | None = None.
  • Từ khóa Python như class, from hay type được thêm gạch dưới ở cuối (class_).
  • from __future__ import annotations được thêm vào để các class tham chiếu lẫn nhau bất kể thứ tự.
  • Mảng ở cấp cao nhất cho ra alias như Root = list[RootItem].

Trường hợp sử dụng

Response model và body request của FastAPI

Dựng BaseModel từ JSON đã thống nhất với frontend rồi dùng trong response_model= hoặc làm tham số endpoint; tài liệu OpenAPI tự động theo sau.

Validate response của API bên thứ ba

Bọc lời gọi trong Forecast.model_validate(resp.json()), khi nhà cung cấp đổi kiểu một field, ValidationError sẽ chỉ đúng đường dẫn field bị hỏng.

Thay thế việc tra dict trong script

Đổi data["current"]["temp"] thành forecast.current.temp giúp có gợi ý code trong editor và cho mypy hay pyright kiểm tra code.

Lưu ý và giới hạn

  • @dataclass không chuyển dict lồng nhau thành object. Sau Forecast(**data), current vẫn là dict; hãy dùng Pydantic hoặc helper như dacite nếu cần chuyển đổi lồng nhau.
  • Để serialize ngược lại với key JSON gốc (updatedAt) trong Pydantic, gọi model_dump(by_alias=True) hoặc model_dump_json(by_alias=True).
  • Output dùng cú pháp str | None, nên model Pydantic giả định Python 3.10 trở lên.
  • Chuỗi ngày giờ ra dạng str. Với Pydantic, chỉ cần đổi annotation thành datetime là parse được giá trị ISO 8601.
  • Không tạo cấu trúc của Pydantic v1 (class Config, parse_obj).

Câu hỏi thường gặp

populate_by_name=True để làm gì?

Mặc định field có alias chỉ nhận alias (updatedAt) làm đầu vào. Với thiết lập này bạn có thể viết cả Forecast(updated_at=...), tiện khi viết test.

Tôi thích dùng Optional[str] cho field tùy chọn.

str | None và Optional[str] có nghĩa như nhau. Nếu cần tương thích Python 3.9, hãy import Optional từ typing và đổi các annotation.

Có xuất được TypedDict hay class attrs không?

Các kiểu được hỗ trợ là Pydantic v2 và dataclass. Danh sách field của dataclass chuyển thẳng sang TypedDict hoặc class @attrs.define nếu bạn cần một trong hai.

Khi key đã là snake_case thì có thêm alias không?

Không. Khi tên Python trùng với key gốc, không có Field(alias=...) hay ConfigDict nào được xuất ra, nên bạn nhận được dòng đơn giản như rain_mm: float.