Cole models Python escritos com BaseModel do Pydantic, @dataclass ou TypedDict e receba de volta um JSON de exemplo que segue a estrutura deles. Field(alias=...) e uma configuração alias_generator=to_camel são lidos, então você vê as chaves para as quais os seus campos snake_case realmente são serializados.
Combina com montar exemplos de request para endpoints FastAPI, compartilhar com outro time o schema de um payload de webhook ou de fila, ou preparar fixtures JSON para o pytest.
.py que tem os seus models. Linhas de import, métodos e decorators como @field_validator são pulados.Enum para que essas partes sejam preenchidas. Forward references em string ("Order") são entendidas.Automático, o Tipo raiz escolhe a classe que não é usada como tipo de campo por outro model; você também pode escolher uma na lista.examples do json_schema_extra, um arquivo de dados de teste ou a documentação da sua 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
}Por causa do to_camel no model_config, event_type, receipt_url e customer_id viram chaves em camelCase, enquanto o alias="retries" explícito vence para retry_count. raw_payload tem Field(exclude=True) e é omitido. O Literal usa o primeiro valor, payment.succeeded, e o default literal "KRW" é mantido como está.
BaseModel do Pydantic (v1 e v2), @dataclass, TypedDict e Enum/StrEnum/IntEnum, incluindo auto().Field(alias=...), serialization_alias e alias_generator (to_camel, to_pascal) definido em model_config = ConfigDict(...) ou numa class Config: interna._, ClassVar, model_config e campos com Field(exclude=True).Optional[X] / X | None → exemplo de X, Literal[...] → primeiro valor, Annotated/Required/NotRequired → tipo interno, list/set/tuple → array de um elemento, dict[str, V] → {"key": V}.EmailStr, HttpUrl, SecretStr, constr → string; conint, PositiveInt → 0; Decimal e condecimal → a string "0", como o JSON do Pydantic v2 os escreve.datetime → 1970-01-01T00:00:00, date → 1970-01-01, time → 00:00:00, timedelta → PT0S; UUID recebe um valor bem formado.True/False são usados como exemplo; um default de enum como Status.PAID vira o valor desse membro.Gere o JSON a partir de um model de request e coloque em model_config = {"json_schema_extra": {"examples": [...]}}; o exemplo em /docs passa a usar as mesmas chaves de alias que o endpoint espera.
Se os payloads de tasks do Celery ou de mensagens do Kafka estão definidos em Pydantic, entregue aos times consumidores em Node ou Go o JSON resultante, em vez de código Python, para combinar a estrutura.
Crie o esqueleto de um arquivo JSON para model_validate_json() ou para testes de client de API e depois mude valores individuais para adicionar casos de borda.
Optional e campos com default None ainda recebem um exemplo do tipo em vez de null.Decimal é preenchido como a string "0", igual à serialização JSON do Pydantic v2 (model_dump_json). Se o seu projeto emite números (Pydantic v1, ou json.dumps(default=float)), troque por um número.@computed_field, @field_serializer ou @model_serializer, não é executado.Union[A, B] usa o primeiro membro que não é None; discriminated unions selecionadas por um campo discriminator não são modeladas.default_factory e defaults gerados por chamadas de função não são executados; o valor vem do tipo.model_dump_json() imprime os nomes dos campos.O Pydantic serializa pelo nome do campo, a menos que você passe by_alias=True. O response_model do FastAPI usa by_alias=True por padrão, o que bate com a saída desta ferramenta. Ao fazer o dump você mesmo, chame model_dump_json(by_alias=True).
A dataclass padrão não tem renomeação, então o nome do campo é a chave. Se um campo traz um comentário # JSON: "orderId" no final, como nas dataclasses geradas pela página JSON → Python deste site, esse nome é usado.
NotRequired de um TypedDict são incluídas?Sim. O exemplo é feito para mostrar todas as chaves possíveis, então campos NotRequired e total=False são incluídos. Marque na sua documentação os que podem ser omitidos.
Esta página é para models baseados em type hints. Para models do SQLAlchemy declarados com Column(...) ou Mapped[...], use a página SQLAlchemy → JSON.