Pydantic BaseModel, @dataclass या TypedDict से लिखे Python models पेस्ट करें और उनकी संरचना का पालन करने वाला उदाहरण JSON document पाएं। Field(alias=...) और alias_generator=to_camel config पढ़े जाते हैं, इसलिए आप देखते हैं कि आपके snake_case fields असल में किन keys में serialize होते हैं।
यह FastAPI endpoints के request examples बनाने, किसी दूसरी टीम के साथ webhook या queue payload schema साझा करने, या pytest के लिए JSON fixtures तैयार करने के लिए ठीक है।
.py फ़ाइल की सामग्री पेस्ट करें। import lines, methods और @field_validator जैसे decorators छोड़ दिए जाते हैं।Enum classes शामिल करें, ताकि वे हिस्से भरें। String forward references ("Order") समझे जाते हैं।स्वचालित पर रूट टाइप वह class चुनता है जो किसी दूसरे model में field type के रूप में इस्तेमाल नहीं होती; सूची से भी कोई चुन सकते हैं।json_schema_extra के examples, test data फ़ाइल या अपने API docs में कॉपी करें।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
}model_config में to_camel की वजह से event_type, receipt_url और customer_id camelCase keys बन जाते हैं, जबकि retry_count के लिए explicit alias="retries" जीतता है। raw_payload पर Field(exclude=True) है और वह छोड़ दिया जाता है। Literal अपनी पहली वैल्यू payment.succeeded लेता है, और literal default "KRW" जैसा है वैसा रहता है।
BaseModel (v1 और v2), @dataclass, TypedDict, और auto() समेत Enum/StrEnum/IntEnum पढ़ता है।Field(alias=...), serialization_alias, और model_config = ConfigDict(...) या अंदर की class Config: में सेट alias_generator (to_camel, to_pascal) से।_ से शुरू होने वाले नाम, ClassVar, model_config, और Field(exclude=True) fields।Optional[X] / X | None → X का sample, Literal[...] → पहली वैल्यू, Annotated/Required/NotRequired → अंदर का type, list/set/tuple → एक element वाला array, dict[str, V] → {"key": V}।EmailStr, HttpUrl, SecretStr, constr → string; conint, PositiveInt → 0; Decimal और condecimal → string "0", जैसा Pydantic v2 JSON उन्हें लिखता है।datetime → 1970-01-01T00:00:00, date → 1970-01-01, time → 00:00:00, timedelta → PT0S; UUID को सही रूप वाली वैल्यू मिलती है।True/False literal defaults samples के रूप में इस्तेमाल होते हैं; Status.PAID जैसा enum default उस member की वैल्यू बनता है।Request model से JSON बनाकर model_config = {"json_schema_extra": {"examples": [...]}} में डालें; तब /docs पर example वही alias keys इस्तेमाल करता है जिनकी endpoint अपेक्षा करता है।
अगर Celery task या Kafka message payloads Pydantic में define हैं, तो संरचना पर सहमति के लिए Node या Go वाली consumer टीमों को Python कोड की बजाय बना हुआ JSON दें।
model_validate_json() या API client tests के लिए JSON फ़ाइल का ढांचा बनाएं, फिर edge cases जोड़ने के लिए अलग-अलग values बदलें।
Optional fields और None default वाले fields को भी null की बजाय typed sample मिलता है।Decimal string "0" के रूप में भरा जाता है, जो Pydantic v2 JSON serialization (model_dump_json) से मेल खाता है। अगर आपका project इसकी जगह numbers निकालता है (Pydantic v1, या json.dumps(default=float)), तो इसे number में बदलें।@computed_field, @field_serializer या @model_serializer, चलाया नहीं जाता।Union[A, B] पहला non-None member इस्तेमाल करता है; discriminator field से चुने जाने वाले discriminated unions modeled नहीं हैं।default_factory और function calls से बनने वाले defaults चलाए नहीं जाते; वैल्यू type से आती है।model_dump_json() field नाम छापता है।जब तक आप by_alias=True न दें, Pydantic field नाम से serialize करता है। FastAPI का response_model default रूप से by_alias=True इस्तेमाल करता है, जो इस टूल के आउटपुट से मेल खाता है। खुद dump करते समय model_dump_json(by_alias=True) call करें।
Standard dataclass में renaming नहीं है, इसलिए field नाम ही key है। अगर किसी field के अंत में # JSON: "orderId" comment हो, जैसा इस साइट के JSON → Python पेज से बने dataclasses में होता है, तो वह नाम इस्तेमाल होता है।
TypedDict की NotRequired keys शामिल होती हैं?हां। Sample का मकसद हर संभव key दिखाना है, इसलिए NotRequired और total=False fields शामिल होते हैं। अपने docs में चिह्नित करें कि कौन से छोड़े जा सकते हैं।
यह पेज type-hint आधारित models के लिए है। Column(...) या Mapped[...] से declare किए SQLAlchemy models के लिए SQLAlchemy → JSON पेज इस्तेमाल करें।