Ubah kelas Python menjadi JSON!

Tempel kode Python (Pydantic·dataclass) dan dapatkan contoh JSON! Mendukung Pydantic BaseModel, Field(alias), dataclass, TypedDict. Berguna untuk dokumentasi API dan body request uji (mock request body).
Python
Hasil
 

Ubah kelas Python menjadi JSON!

Tempel model Python yang ditulis dengan Pydantic BaseModel, @dataclass atau TypedDict, dan dapatkan kembali contoh dokumen JSON yang mengikuti strukturnya. Field(alias=...) dan config alias_generator=to_camel ikut dibaca, jadi Anda melihat key yang benar-benar dihasilkan field snake_case Anda saat di-serialize.

Cocok untuk membuat contoh request bagi endpoint FastAPI, membagikan schema payload webhook atau queue ke tim lain, atau menyiapkan fixture JSON untuk pytest.

Cara menggunakan

  1. Tempel isi file .py yang berisi model Anda. Baris import, method, dan decorator seperti @field_validator dilewati.
  2. Sertakan sub-model dan class Enum yang direferensikan agar bagian itu ikut terisi. Forward reference berupa string ("Order") juga dipahami.
  3. Pada Otomatis, Tipe akar memilih class yang tidak dipakai model lain sebagai tipe field; Anda juga bisa memilihnya dari daftar.
  4. Salin JSON ke examples di json_schema_extra, file data uji, atau dokumentasi API Anda.

Contoh

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
}

Karena to_camel di model_config, event_type, receipt_url dan customer_id berubah menjadi key camelCase, sedangkan alias="retries" yang eksplisit diutamakan untuk retry_count. raw_payload memiliki Field(exclude=True) dan dihilangkan. Literal mengambil nilai pertamanya, payment.succeeded, dan default literal "KRW" dipertahankan apa adanya.

Fitur yang didukung

  • Membaca Pydantic BaseModel (v1 dan v2), @dataclass, TypedDict, serta Enum/StrEnum/IntEnum termasuk auto().
  • Nama key dari Field(alias=...), serialization_alias, dan alias_generator (to_camel, to_pascal) yang diatur di model_config = ConfigDict(...) atau inner class Config:.
  • Dikecualikan: nama yang diawali _, ClassVar, model_config, dan field Field(exclude=True).
  • Penanganan tipe: Optional[X] / X | None → contoh dari X, Literal[...] → nilai pertama, Annotated/Required/NotRequired → tipe di dalamnya, list/set/tuple → array satu elemen, dict[str, V] → {"key": V}.
  • Tipe Pydantic: EmailStr, HttpUrl, SecretStr, constr → string; conint, PositiveInt → 0; Decimal dan condecimal → string "0", seperti yang ditulis JSON Pydantic v2.
  • Tanggal dan waktu: datetime → 1970-01-01T00:00:00, date → 1970-01-01, time → 00:00:00, timedelta → PT0S; UUID mendapat nilai yang formatnya valid.
  • Default berupa literal string, angka, dan True/False dipakai sebagai contoh; default enum seperti Status.PAID menjadi nilai member tersebut.

Kasus penggunaan

Contoh request FastAPI

Buat JSON dari model request dan masukkan ke model_config = {"json_schema_extra": {"examples": [...]}}; contoh di /docs kemudian memakai key alias yang sama dengan yang diharapkan endpoint.

Berbagi payload webhook dan event

Jika payload task Celery atau pesan Kafka didefinisikan dengan Pydantic, berikan JSON hasilnya ke tim konsumen di Node atau Go, bukan kode Python, untuk menyepakati strukturnya.

Menyiapkan fixture pytest

Buat kerangka file JSON untuk model_validate_json() atau test API client, lalu ubah nilai-nilai tertentu untuk menambahkan edge case.

Catatan dan batasan

  • Field Optional dan field dengan default None tetap mendapat contoh sesuai tipe, bukan null.
  • Decimal diisi sebagai string "0", sesuai serialisasi JSON Pydantic v2 (model_dump_json). Jika proyek Anda mengeluarkan number (Pydantic v1, atau json.dumps(default=float)), ubah menjadi number.
  • Kode yang mengubah bentuk output, seperti @computed_field, @field_serializer atau @model_serializer, tidak dijalankan.
  • Union[A, B] memakai anggota pertama yang bukan None; discriminated union yang dipilih lewat field discriminator tidak dimodelkan.
  • default_factory dan default hasil pemanggilan fungsi tidak dijalankan; nilainya diambil dari tipe.

FAQ

Output memakai key alias, tetapi model_dump_json() saya mencetak nama field.

Pydantic men-serialize berdasarkan nama field kecuali Anda memberikan by_alias=True. response_model FastAPI memakai by_alias=True secara default, yang cocok dengan output alat ini. Saat melakukan dump sendiri, panggil model_dump_json(by_alias=True).

Dataclass tidak punya alias. Apakah key tetap bisa berbeda dari nama field?

dataclass standar tidak punya fitur penggantian nama, jadi nama field adalah key-nya. Jika sebuah field membawa komentar # JSON: "orderId" di belakangnya, seperti pada dataclass yang dihasilkan halaman JSON → Python di situs ini, nama itulah yang dipakai.

Apakah key NotRequired dari TypedDict disertakan?

Ya. Contoh ini dimaksudkan untuk menampilkan setiap key yang mungkin, jadi field NotRequired dan total=False disertakan. Tandai di dokumentasi Anda mana yang boleh dihilangkan.

Apakah bisa menangani model SQLAlchemy?

Halaman ini untuk model berbasis type hint. Untuk model SQLAlchemy yang dideklarasikan dengan Column(...) atau Mapped[...], gunakan halaman SQLAlchemy → JSON.