¡Convierte clases de Python a JSON!

¡Pega código Python (Pydantic·dataclass) y obtén un JSON de ejemplo! Compatible con Pydantic BaseModel, Field(alias), dataclass, TypedDict. Útil para documentar APIs y cuerpos de petición de prueba (mock request body).
Python
Resultado
 

¡Convierte clases de Python a JSON!

Pega modelos de Python escritos con BaseModel de Pydantic, @dataclass o TypedDict, y obtén un documento JSON de ejemplo que sigue su estructura. Se leen Field(alias=...) y una configuración alias_generator=to_camel, así que ves las claves a las que realmente se serializan tus campos snake_case.

Encaja para construir ejemplos de petición para endpoints de FastAPI, para compartir con otro equipo el schema del payload de un webhook o de una cola, o para preparar fixtures JSON para pytest.

Cómo usar

  1. Pega el contenido del archivo .py que contiene tus modelos. Se omiten las líneas import, los métodos y los decoradores como @field_validator.
  2. Incluye los submodelos referenciados y las clases Enum para que esas partes se rellenen. Se entienden las referencias adelantadas en forma de cadena ("Order").
  3. En Automático, Tipo raíz elige la clase que ningún otro modelo usa como tipo de campo; también puedes elegir una de la lista.
  4. Copia el JSON en los examples de json_schema_extra, en un archivo de datos de prueba o en la documentación de tu API.

Ejemplo

Entrada (Python · Pydantic)
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)
Salida (JSON)
{
  "eventType": "payment.succeeded",
  "amount": "0",
  "currency": "KRW",
  "payer": {
    "customerId": "",
    "emailAddress": ""
  },
  "receiptUrl": "",
  "retries": 0
}

Por el to_camel de model_config, event_type, receipt_url y customer_id pasan a claves camelCase, mientras que el alias="retries" explícito gana en retry_count. raw_payload tiene Field(exclude=True) y se omite. El Literal toma su primer valor, payment.succeeded, y el valor por defecto literal "KRW" se conserva tal cual.

Funciones compatibles

  • Lee BaseModel de Pydantic (v1 y v2), @dataclass, TypedDict y Enum/StrEnum/IntEnum, incluido auto().
  • Nombres de clave desde Field(alias=...), serialization_alias y alias_generator (to_camel, to_pascal) configurados en model_config = ConfigDict(...) o en una class Config: interna.
  • Se excluyen: los nombres que empiezan por _, ClassVar, model_config y los campos con Field(exclude=True).
  • Manejo de tipos: Optional[X] / X | None → ejemplo de X, Literal[...] → primer valor, Annotated/Required/NotRequired → tipo interior, list/set/tuple → array de un elemento, dict[str, V] → {"key": V}.
  • Tipos de Pydantic: EmailStr, HttpUrl, SecretStr, constr → cadena; conint, PositiveInt → 0; Decimal y condecimal → la cadena "0", como los escribe el JSON de Pydantic v2.
  • Fechas y horas: datetime → 1970-01-01T00:00:00, date → 1970-01-01, time → 00:00:00, timedelta → PT0S; UUID recibe un valor con el formato correcto.
  • Los valores por defecto literales de cadena, número y True/False se usan como ejemplo; un valor por defecto de enum como Status.PAID pasa a ser el valor de ese miembro.

Casos de uso

Ejemplos de petición en FastAPI

Genera JSON a partir de un modelo de petición y colócalo en model_config = {"json_schema_extra": {"examples": [...]}}; el ejemplo de /docs usará entonces las mismas claves alias que espera el endpoint.

Compartir payloads de webhooks y eventos

Si los payloads de tareas de Celery o mensajes de Kafka están definidos en Pydantic, entrega a los equipos consumidores en Node o Go el JSON resultante en lugar de código Python para acordar la estructura.

Preparar fixtures de pytest

Crea el esqueleto de un archivo JSON para model_validate_json() o para tests de un cliente de API, y luego cambia valores concretos para añadir casos límite.

Notas y limitaciones

  • Los campos Optional y los que tienen None por defecto reciben igualmente un ejemplo tipado en lugar de null.
  • Decimal se rellena con la cadena "0", igual que la serialización JSON de Pydantic v2 (model_dump_json). Si tu proyecto emite números en su lugar (Pydantic v1, o json.dumps(default=float)), cámbialo a número.
  • No se ejecuta el código que transforma la salida, como @computed_field, @field_serializer o @model_serializer.
  • Union[A, B] usa el primer miembro que no es None; no se modelan las uniones discriminadas que se seleccionan mediante un campo discriminator.
  • No se ejecutan default_factory ni los valores por defecto producidos por llamadas a funciones; el valor sale del tipo.

Preguntas frecuentes

La salida usa claves alias, pero mi model_dump_json() imprime los nombres de los campos.

Pydantic serializa por nombre de campo a menos que pases by_alias=True. El response_model de FastAPI usa by_alias=True por defecto, lo que coincide con la salida de esta herramienta. Si haces el dump tú, llama a model_dump_json(by_alias=True).

Los dataclasses no tienen alias. ¿Pueden las claves diferir de los nombres de campo?

El dataclass estándar no tiene renombrado, así que el nombre del campo es la clave. Si un campo lleva al final un comentario # JSON: "orderId", como en los dataclasses que produce la página JSON → Python de este sitio, se usa ese nombre.

¿Se incluyen las claves NotRequired de un TypedDict?

Sí. El ejemplo pretende mostrar todas las claves posibles, así que se incluyen los campos NotRequired y total=False. Marca en tu documentación los que pueden omitirse.

¿Maneja modelos de SQLAlchemy?

Esta página es para modelos basados en type hints. Para modelos de SQLAlchemy declarados con Column(...) o Mapped[...], usa la página SQLAlchemy → JSON.