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.
.py yang berisi model Anda. Baris import, method, dan decorator seperti @field_validator dilewati.Enum yang direferensikan agar bagian itu ikut terisi. Forward reference berupa string ("Order") juga dipahami.Otomatis, Tipe akar memilih class yang tidak dipakai model lain sebagai tipe field; Anda juga bisa memilihnya dari daftar.examples di json_schema_extra, file data uji, atau dokumentasi API Anda.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){
"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.
BaseModel (v1 dan v2), @dataclass, TypedDict, serta Enum/StrEnum/IntEnum termasuk auto().Field(alias=...), serialization_alias, dan alias_generator (to_camel, to_pascal) yang diatur di model_config = ConfigDict(...) atau inner class Config:._, ClassVar, model_config, dan field Field(exclude=True).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}.EmailStr, HttpUrl, SecretStr, constr → string; conint, PositiveInt → 0; Decimal dan condecimal → string "0", seperti yang ditulis JSON Pydantic v2.datetime → 1970-01-01T00:00:00, date → 1970-01-01, time → 00:00:00, timedelta → PT0S; UUID mendapat nilai yang formatnya valid.True/False dipakai sebagai contoh; default enum seperti Status.PAID menjadi nilai member tersebut.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.
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.
Buat kerangka file JSON untuk model_validate_json() atau test API client, lalu ubah nilai-nilai tertentu untuk menambahkan edge case.
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.@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.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 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.
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.
Halaman ini untuk model berbasis type hint. Untuk model SQLAlchemy yang dideklarasikan dengan Column(...) atau Mapped[...], gunakan halaman SQLAlchemy → JSON.