Вставьте модели Python, написанные через Pydantic BaseModel, @dataclass или TypedDict, и получите пример JSON-документа, повторяющий их структуру. Field(alias=...) и конфигурация alias_generator=to_camel учитываются, так что вы видите, в какие ключи на самом деле сериализуются ваши поля в snake_case.
Подходит для создания примеров запросов к эндпоинтам FastAPI, передачи схемы payload вебхука или очереди другой команде, а также подготовки JSON-фикстур для pytest.
.py-файла с моделями. Строки import, методы и декораторы вроде @field_validator пропускаются.Enum, чтобы эти части были заполнены. Строковые forward-ссылки ("Order") понимаются.Автоматически Корневой тип выбирает класс, который не используется как тип поля в другой модели; можно также выбрать класс из списка.examples внутри json_schema_extra, в файл тестовых данных или в документацию 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
}Из-за to_camel в model_config поля event_type, receipt_url и customer_id превращаются в ключи в camelCase, а для retry_count побеждает явный alias="retries". У raw_payload стоит Field(exclude=True), и он опущен. Literal берёт своё первое значение, payment.succeeded, а литеральное значение по умолчанию "KRW" сохраняется как есть.
BaseModel (v1 и v2), @dataclass, TypedDict, а также Enum/StrEnum/IntEnum, включая auto().Field(alias=...), serialization_alias и alias_generator (to_camel, to_pascal), заданного в model_config = ConfigDict(...) или во внутреннем class Config:._, 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 → строка "0", как их пишет JSON в Pydantic v2.datetime → 1970-01-01T00:00:00, date → 1970-01-01, time → 00:00:00, timedelta → PT0S; UUID получает корректно сформированное значение.True/False — используются как примеры; значение enum по умолчанию вроде Status.PAID становится значением этого члена.Сгенерируйте JSON из модели запроса и поместите его в model_config = {"json_schema_extra": {"examples": [...]}}; пример на /docs тогда использует те же ключи-алиасы, которых ждёт эндпоинт.
Если payload задач Celery или сообщений Kafka описаны на Pydantic, дайте командам-потребителям на Node или Go полученный JSON, а не Python-код, чтобы согласовать структуру.
Создайте каркас JSON-файла для model_validate_json() или тестов API-клиента, затем меняйте отдельные значения, добавляя пограничные случаи.
Optional и поля со значением по умолчанию None всё равно получают типизированный пример вместо null.Decimal заполняется строкой "0" в соответствии с JSON-сериализацией Pydantic v2 (model_dump_json). Если ваш проект выдаёт числа (Pydantic v1 или json.dumps(default=float)), поменяйте на число.@computed_field, @field_serializer или @model_serializer, не выполняется.Union[A, B] использует первый член, отличный от None; discriminated unions, выбираемые по полю discriminator, не моделируются.default_factory и значения по умолчанию из вызовов функций не выполняются; значение берётся из типа.model_dump_json() печатает имена полей.Pydantic сериализует по имени поля, если не передать by_alias=True. response_model в FastAPI по умолчанию использует by_alias=True, что совпадает с выводом этого инструмента. При самостоятельной выгрузке вызывайте model_dump_json(by_alias=True).
Стандартный dataclass не умеет переименовывать, так что ключ — имя поля. Если у поля есть комментарий в конце строки # JSON: "orderId", как в dataclass, созданных страницей JSON → Python этого сайта, используется это имя.
NotRequired из TypedDict?Да. Пример должен показывать все возможные ключи, поэтому поля NotRequired и total=False включаются. Пометьте в документации те, что могут отсутствовать.
Эта страница для моделей на основе аннотаций типов. Для моделей SQLAlchemy, объявленных через Column(...) или Mapped[...], используйте страницу SQLAlchemy → JSON.