¡Convierte modelos de SQLAlchemy en JSON!

¡Introduce modelos de SQLAlchemy para generar JSON de ejemplo! Compatible con SQLAlchemy ORM. Útil para documentar APIs y cuerpos de petición de prueba (mock request body).
SQLAlchemy
Resultado
 

¡Convierte modelos de SQLAlchemy en JSON!

Pega clases de modelo de SQLAlchemy y obtén JSON de ejemplo con los nombres de los atributos de columna como claves. Lee Mapped[...] con mapped_column() al estilo 2.0, Column() al estilo 1.x y db.Column() de Flask-SQLAlchemy, e incorpora las columnas de mixins y clases padre.

Los modelos de SQLAlchemy no se pueden pasar directamente a json.dumps, así que las apps de FastAPI y Flask añaden schemas de Pydantic o Marshmallow. Úsalo para ver qué campos expondrá un modelo antes de escribir ese schema, o para construir bodies de petición para tests.

Cómo usar

  1. Pega el archivo de modelos en el cuadro SQLAlchemy. Mantén Base, los mixins y las clases enum.Enum en la misma entrada para que se resuelvan las columnas heredadas y los valores de los enums.
  2. Solo las clases con __tablename__ cuentan como modelos. Varios modelos se emiten por nombre de clase, como { "User": {...}, "Team": {...} }.
  3. Copia el resultado.

Ejemplo

Entrada (Python · Flask-SQLAlchemy)
class TimestampMixin:
    created_at = db.Column(db.DateTime, default=datetime.utcnow)


class Plan(enum.Enum):
    FREE = "free"
    PRO = "pro"


class Subscription(TimestampMixin, db.Model):
    __tablename__ = "subscriptions"

    id = db.Column(db.Integer, primary_key=True)
    plan = db.Column(db.Enum(Plan), nullable=False)
    seats = db.Column(db.SmallInteger, default=1)
    trial_ends = db.Column(db.Date)
    user_id = db.Column(db.Integer, db.ForeignKey("users.id"))
    user = db.relationship("User", backref="subscriptions")
Salida (JSON)
{
  "created_at": "1970-01-01T00:00:00",
  "id": 0,
  "plan": "free",
  "seats": 1,
  "trial_ends": "1970-01-01",
  "user_id": 0
}

created_at de TimestampMixin va primero, siguiendo el orden de herencia, y user se descarta porque relationship() no es una columna. db.Enum(Plan) toma el primer valor del enum, "free", y db.Date pasa a 1970-01-01. seats muestra 1 por default=1, mientras que created_at conserva el placeholder porque datetime.utcnow es una función.

Funciones compatibles

  • Los type hints de Python como Mapped[int], Mapped[Optional[str]] y Mapped[str | None] deciden el valor.
  • Sin type hint, decide el argumento de tipo SQL, como en Column(String(50)) o db.Column(db.Numeric).
  • DateTime → 1970-01-01T00:00:00, Date → 1970-01-01, Time → 00:00:00, JSON/JSONB → {}, Uuid → un UUID todo ceros.
  • ARRAY(String) y Mapped[list[str]] pasan a arrays de un elemento.
  • Una clase que extiende enum.Enum, usada mediante Enum(Plan) o Mapped[Plan], aporta el valor de su primer miembro.
  • Se excluyen relationship(), column_property(), las variables de clase simples y los atributos dunder como __table_args__.
  • Las columnas de mixins y modelos padre se colocan antes de las columnas propias del hijo.

Casos de uso

Esbozar un modelo de respuesta de Pydantic

Antes de escribir la clase Pydantic para el response_model de FastAPI, comprueba los campos y tipos que el modelo expone como JSON. Pasa ese JSON a la página de JSON a Python para obtener también un borrador en Pydantic.

Payloads de prueba para una API Flask

Construye el body de client.post("/subscriptions", json=...) con claves que coinciden con los atributos del modelo. Quita antes el id autoincremental y la fecha de creación.

Notas y limitaciones

  • Un default= literal ("new", 1, True, None) se usa como valor de ejemplo; los callables como datetime.utcnow o dict no se ejecutan. server_default= y nullable= no se leen.
  • Si una columna tiene un nombre distinto en la base de datos, como en Column("user_name", String), la clave JSON sigue siendo el nombre del atributo de Python.
  • No se incluyen los objetos relacionados cargados mediante relationship. Añade tú los objetos anidados si tu respuesta los incrusta.
  • Los atributos calculados como hybrid_property o @property no forman parte de la salida.

Preguntas frecuentes

¿Por qué Mapped[Optional[str]] es una cadena vacía y no null?

Optional significa que se permite None; el ejemplo muestra el caso en que hay valor, así que usa el str interior. Cámbialo a null en la salida si necesitas ese caso.

¿Por qué las fechas y horas no tienen Z ni offset?

Las columnas DateTime son naive por defecto, y isoformat() las imprime sin offset. Si usas DateTime(timezone=True), un ejemplo con +00:00 se acerca más a lo que verás en realidad.

¿Puede convertir modelos de Django?

No. Esta página solo entiende la sintaxis Column, mapped_column y Mapped de SQLAlchemy; los campos de Django como models.CharField no se reconocen.