Ubah JSON menjadi Pydantic model Python!

Masukkan JSON untuk membuat kode Pydantic model Python, termasuk objek bersarang! Mendukung Pydantic v2 BaseModel, dataclass, FastAPI. SQLAlchemy ada di tab di atas.
JSON
Hasil
 

Ubah JSON menjadi Pydantic model Python!

Konverter ini mengubah struktur JSON menjadi class Pydantic v2 BaseModel atau kode @dataclass dari standard library. Nama field ditulis ulang ke snake_case sesuai gaya Python, dan setiap objek bersarang mendapat class sendiri.

Gunakan saat mendefinisikan schema request dan response FastAPI, saat menambahkan type hint ke data yang Anda ambil dengan requests atau httpx, atau saat merapikan skrip ETL dan scraping yang menggali dict lewat key string.

Cara menggunakan

  1. Tempel JSON yang ingin Anda modelkan.
  2. Isi nama model tingkat atas di Nama tipe (misalnya Forecast).
  3. Di Gaya, pilih Pydantic (v2) untuk validasi dan alias, atau dataclass untuk model tanpa dependensi.
  4. Salin hasilnya ke module seperti models.py. Gaya dan nama tipe disimpan di URL.

Contoh

Input (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" }
  ]
}
Output (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 menjadi field updated_at, yang dihubungkan kembali ke key aslinya dengan Field(alias="updatedAt"). Di hourly, temp mencampur integer dan desimal sehingga menjadi float, dan alert, yang hanya ada di item kedua, menjadi str | None = None. Class dikeluarkan mulai dari anak terlebih dahulu.

Fitur yang didukung

  • Pydantic v2: field yang diganti namanya memakai Field(alias=...), dan model_config = ConfigDict(populate_by_name=True) memungkinkan Anda juga mengisinya dengan nama Python-nya.
  • dataclass: field tanpa default dipindahkan ke depan field = None untuk menghindari TypeError: non-default argument follows default argument; key aslinya disimpan sebagai komentar # JSON: "updatedAt".
  • Tipe: str, int, float, bool, list[...], dan Any untuk nilai bertipe campuran.
  • Field yang tidak ada di sebagian item atau berisi null menjadi X | None = None.
  • Keyword Python seperti class, from atau type diberi garis bawah di belakang (class_).
  • from __future__ import annotations disertakan agar class bisa saling mereferensikan apa pun urutannya.
  • Array tingkat atas menghasilkan alias seperti Root = list[RootItem].

Kasus penggunaan

Response model dan body request FastAPI

Bangun BaseModel dari JSON yang sudah Anda sepakati dengan frontend dan gunakan di response_model= atau sebagai parameter endpoint; dokumentasi OpenAPI otomatis mengikuti.

Memvalidasi respons API pihak ketiga

Bungkus pemanggilan dengan Forecast.model_validate(resp.json()), dan ketika penyedia mengubah tipe sebuah field, ValidationError menunjuk path field persis yang rusak.

Mengganti lookup dict di skrip

Mengubah data["current"]["temp"] menjadi forecast.current.temp memberi Anda autocomplete di editor dan memungkinkan mypy atau pyright memeriksa kodenya.

Catatan dan batasan

  • @dataclass tidak mengubah dict bersarang menjadi objek. Setelah Forecast(**data), current tetap berupa dict; gunakan Pydantic atau helper seperti dacite jika Anda butuh konversi bersarang.
  • Untuk men-serialize kembali dengan key JSON asli (updatedAt) di Pydantic, panggil model_dump(by_alias=True) atau model_dump_json(by_alias=True).
  • Output memakai sintaks str | None, jadi model Pydantic mengasumsikan Python 3.10 atau lebih baru.
  • String tanggal dan waktu keluar sebagai str. Dengan Pydantic, cukup ubah anotasinya menjadi datetime untuk mem-parse nilai ISO 8601.
  • Konstruksi Pydantic v1 (class Config, parse_obj) tidak dibuat.

FAQ

Untuk apa populate_by_name=True?

Secara default, field yang memiliki alias hanya menerima alias-nya (updatedAt) sebagai input. Dengan pengaturan ini Anda juga bisa menulis Forecast(updated_at=...), yang praktis di test.

Saya lebih suka Optional[str] untuk field opsional.

str | None dan Optional[str] artinya sama. Jika Anda butuh kompatibilitas Python 3.9, import Optional dari typing lalu ganti anotasinya.

Bisakah menghasilkan TypedDict atau class attrs?

Gaya yang didukung adalah Pydantic v2 dan dataclass. Daftar field dataclass bisa langsung dipindahkan ke TypedDict atau class @attrs.define jika Anda butuh salah satunya.

Apakah alias ditambahkan jika key-nya sudah snake_case?

Tidak. Jika nama Python sama dengan key aslinya, tidak ada Field(alias=...) atau ConfigDict yang dikeluarkan, jadi Anda mendapat baris sederhana seperti rain_mm: float.