Pydantic BaseModel, @dataclass, TypedDict로 정의한 Python 모델을 붙여넣으면 그 구조에 맞춘 예시 JSON을 돌려줍니다. Field(alias=...)와 alias_generator=to_camel 설정을 읽어서 snake_case 필드가 실제로 어떤 키로 나가는지 그대로 보여 줍니다.
FastAPI 엔드포인트의 요청 예시를 만들거나, 웹훅·메시지 큐 페이로드 스키마를 다른 팀에 공유하거나, pytest 픽스처용 JSON을 준비할 때 쓰기 좋습니다.
.py 파일 내용을 붙여넣습니다. import 문, 메서드, @field_validator 같은 데코레이터는 건너뜁니다.Enum 클래스도 함께 넣어야 그 부분이 채워집니다. 문자열로 쓴 앞방향 참조("Order")도 인식합니다.최상위 타입을 자동으로 두면 다른 모델의 필드 타입으로 쓰이지 않는 클래스가 선택되고, 목록에서 직접 고를 수도 있습니다.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 키로 바뀌었고, retry_count는 직접 지정한 alias="retries"가 우선합니다. Field(exclude=True)인 raw_payload는 빠지며, Literal은 첫 번째 값 payment.succeeded, 리터럴 기본값 "KRW"는 그대로 들어갑니다.
BaseModel(v1·v2), @dataclass, TypedDict, Enum·StrEnum·IntEnum(auto() 포함).Field(alias=...), serialization_alias, model_config = ConfigDict(alias_generator=to_camel) 또는 class Config:의 alias_generator(to_camel, to_pascal)._로 시작하는 이름, ClassVar, model_config, Field(exclude=True).Optional[X]·X | None → X의 예시 값, Literal[...] → 첫 값, Annotated·Required·NotRequired → 안쪽 타입, list·set·tuple → 원소 하나인 배열, dict[str, V] → {"key": V}.EmailStr·HttpUrl·SecretStr·constr → 문자열, conint·PositiveInt → 0, Decimal·condecimal → Pydantic v2 JSON처럼 문자열 "0".datetime → 1970-01-01T00:00:00, date → 1970-01-01, time → 00:00:00, timedelta → PT0S, UUID도 형식에 맞는 값.True/False 리터럴이면 예시로 쓰고, Status.PAID 같은 enum 기본값은 그 항목의 값으로 바꿉니다.요청 모델을 넣어서 나온 JSON을 model_config = {"json_schema_extra": {"examples": [...]}}에 넣으면 /docs 화면의 예시가 실제 alias 키와 일치합니다.
Celery 작업이나 Kafka 메시지의 페이로드를 Pydantic으로 정의해 두었다면, 소비자 쪽 팀(Node·Go 등)에게 Python 코드 대신 결과 JSON을 건네 구조를 맞출 수 있습니다.
model_validate_json()이나 API 클라이언트 테스트에 쓸 JSON 파일의 뼈대를 만들어 두고, 필요한 값만 바꿔 경계값 케이스를 늘려 가면 됩니다.
Optional 필드나 기본값이 None인 필드도 null 대신 타입의 예시 값으로 채웁니다.Decimal은 Pydantic v2 JSON 직렬화(model_dump_json)처럼 문자열 "0"으로 넣습니다. Pydantic v1이나 json.dumps(default=float)로 숫자로 내보내는 프로젝트라면 숫자로 바꿔 주세요.@computed_field, @field_serializer, @model_serializer처럼 직렬화 결과를 바꾸는 코드는 실행하지 않습니다.Union[A, B]는 None이 아닌 첫 타입만 사용하고, 판별 필드(discriminator)로 고르는 다형성은 반영하지 않습니다.default_factory나 함수 호출로 만든 기본값은 실행하지 않고 타입에서 예시 값을 만듭니다.model_dump_json() 출력은 필드 이름 그대로예요.Pydantic은 기본적으로 필드 이름으로 직렬화하고, by_alias=True를 줘야 alias를 씁니다. FastAPI의 response_model은 기본값이 by_alias=True라 이 도구의 결과와 같습니다. 직접 덤프한다면 model_dump_json(by_alias=True)를 확인해 보세요.
표준 dataclass에는 이름 변경 기능이 없어서 필드 이름이 그대로 키가 됩니다. 이 사이트의 JSON → Python 페이지가 만든 dataclass처럼 필드 뒤에 # JSON: "orderId" 주석이 있으면 그 이름을 키로 씁니다.
TypedDict의 NotRequired 필드도 나오나요?네. 예시 JSON은 가능한 모든 키를 보여 주는 용도라 NotRequired·total=False 필드도 포함합니다. 실제로 생략될 수 있는 키는 문서에서 따로 표시해 주세요.
이 페이지는 타입 힌트 기반 모델용입니다. Column(...)·Mapped[...]로 정의한 SQLAlchemy 모델은 SQLAlchemy → JSON 페이지를 사용하세요.