Pydantic BaseModel, @dataclass বা TypedDict দিয়ে লেখা Python মডেল পেস্ট করুন এবং তাদের গঠন অনুসরণ করা একটি উদাহরণ JSON ডকুমেন্ট ফেরত পান। Field(alias=...) আর alias_generator=to_camel config পড়া হয়, তাই আপনার snake_case ফিল্ডগুলো আসলে কোন key-তে serialize হয় তা দেখতে পান।
FastAPI endpoint-এর request উদাহরণ তৈরি, অন্য টিমের সাথে webhook বা queue payload-এর schema শেয়ার, অথবা pytest-এর JSON fixture প্রস্তুত করার জন্য এটি মানানসই।
.py ফাইলের কনটেন্ট পেস্ট করুন। import লাইন, মেথড আর @field_validator-এর মতো decorator এড়িয়ে যাওয়া হয়।Enum ক্লাসও দিন, যাতে সেই অংশগুলো পূরণ হয়। স্ট্রিং forward reference ("Order") বোঝা যায়।স্বয়ংক্রিয়-এ থাকলে রুট টাইপ এমন ক্লাস বেছে নেয় যা অন্য কোনো মডেল ফিল্ডের type হিসেবে ব্যবহার করে না; তালিকা থেকেও একটি বেছে নিতে পারেন।json_schema_extra-এর examples, টেস্ট ডেটা ফাইল বা আপনার API ডকুমেন্টেশনে বসান।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 key হয়, অন্যদিকে retry_count-এর ক্ষেত্রে স্পষ্ট 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) ফিল্ড।Optional[X] / X | None → X-এর নমুনা, Literal[...] → প্রথম ভ্যালু, Annotated/Required/NotRequired → ভেতরের type, list/set/tuple → এক element-এর array, dict[str, V] → {"key": V}।EmailStr, HttpUrl, SecretStr, constr → স্ট্রিং; conint, PositiveInt → 0; Decimal আর condecimal → স্ট্রিং "0", যেমন Pydantic v2 JSON লেখে।datetime → 1970-01-01T00:00:00, date → 1970-01-01, time → 00:00:00, timedelta → PT0S; UUID সঠিক ফরম্যাটের ভ্যালু পায়।True/False literal default নমুনা হিসেবে ব্যবহৃত হয়; Status.PAID-এর মতো enum default সেই member-এর ভ্যালু হয়।Request মডেল থেকে JSON তৈরি করে model_config = {"json_schema_extra": {"examples": [...]}}-এ বসিয়ে দিন; তাহলে /docs-এর উদাহরণ endpoint যে alias key আশা করে সেগুলোই ব্যবহার করে।
Celery task বা Kafka মেসেজের payload Pydantic-এ ডিফাইন করা থাকলে, গঠন নিয়ে একমত হতে Node বা Go-এর consumer টিমকে Python কোডের বদলে তৈরি হওয়া JSON দিন।
model_validate_json() বা API ক্লায়েন্ট টেস্টের জন্য JSON ফাইলের কাঠামো তৈরি করুন, তারপর edge case যোগ করতে আলাদা আলাদা ভ্যালু বদলান।
Optional ফিল্ড আর None default-এর ফিল্ডও null-এর বদলে টাইপড নমুনা পায়।Decimal স্ট্রিং "0" দিয়ে পূরণ হয়, Pydantic v2 JSON serialization (model_dump_json)-এর সাথে মিলিয়ে। আপনার প্রজেক্ট এর বদলে সংখ্যা বের করলে (Pydantic v1, বা json.dumps(default=float)) সংখ্যায় বদলে নিন।@computed_field, @field_serializer বা @model_serializer-এর মতো আউটপুটের আকৃতি বদলানো কোড চালানো হয় না।Union[A, B] প্রথম non-None member ব্যবহার করে; discriminator ফিল্ড দিয়ে বাছাই হওয়া discriminated union মডেল করা হয় না।default_factory আর ফাংশন কল দিয়ে তৈরি default চালানো হয় না; ভ্যালু আসে type থেকে।model_dump_json() ফিল্ডের নাম প্রিন্ট করে।by_alias=True না দিলে Pydantic ফিল্ডের নাম দিয়ে serialize করে। FastAPI-এর response_model ডিফল্টভাবে by_alias=True ব্যবহার করে, যা এই টুলের আউটপুটের সাথে মেলে। নিজে dump করার সময় model_dump_json(by_alias=True) কল করুন।
সাধারণ dataclass-এ নাম বদলানোর ব্যবস্থা নেই, তাই ফিল্ডের নামই key। এই সাইটের JSON → Python পেজের তৈরি dataclass-এর মতো কোনো ফিল্ডের শেষে # JSON: "orderId" কমেন্ট থাকলে সেই নাম ব্যবহৃত হয়।
TypedDict-এর NotRequired key কি অন্তর্ভুক্ত হয়?হ্যাঁ। নমুনার উদ্দেশ্য সম্ভাব্য প্রতিটি key দেখানো, তাই NotRequired আর total=False ফিল্ডও অন্তর্ভুক্ত। যেগুলো বাদ পড়তে পারে সেগুলো আপনার ডকুমেন্টেশনে চিহ্নিত করুন।
এই পেজ type hint-ভিত্তিক মডেলের জন্য। Column(...) বা Mapped[...] দিয়ে ডিক্লেয়ার করা SQLAlchemy মডেলের জন্য SQLAlchemy → JSON পেজ ব্যবহার করুন।