Convertissez des modèles SQLAlchemy en JSON !

Saisissez des modèles SQLAlchemy pour générer un JSON d'exemple ! Compatible avec SQLAlchemy ORM. Pratique pour documenter une API et créer des corps de requête de test (mock request body).
SQLAlchemy
Résultat
 

Convertissez des modèles SQLAlchemy en JSON !

Collez des classes de modèle SQLAlchemy et obtenez un JSON d'exemple dont les clés sont les noms d'attributs de colonnes. Il lit le style 2.0 Mapped[...] avec mapped_column(), le style 1.x Column() et le db.Column() de Flask-SQLAlchemy, et intègre les colonnes des mixins et des classes parentes.

Les modèles SQLAlchemy ne peuvent pas être passés directement à json.dumps : les applications FastAPI et Flask ajoutent donc des schémas Pydantic ou Marshmallow. Utilisez cet outil pour lister les champs qu'un modèle exposera avant d'écrire ce schéma, ou pour construire des corps de requête de test.

Mode d'emploi

  1. Collez le fichier de modèles dans le champ SQLAlchemy. Gardez Base, les mixins et les classes enum.Enum dans la même entrée pour que les colonnes héritées et les valeurs d'enum soient résolues.
  2. Seules les classes avec __tablename__ comptent comme modèles. Plusieurs modèles sont produits par nom de classe, comme { "User": {...}, "Team": {...} }.
  3. Copiez le résultat.

Exemple

Entrée (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")
Sortie (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 vient en premier, selon l'ordre d'héritage, et user est supprimé car relationship() n'est pas une colonne. db.Enum(Plan) prend la première valeur de l'enum, "free", et db.Date devient 1970-01-01. seats affiche 1 grâce à default=1, tandis que created_at garde la valeur générique car datetime.utcnow est une fonction.

Fonctionnalités prises en charge

  • Les annotations de type Python comme Mapped[int], Mapped[Optional[str]] et Mapped[str | None] déterminent la valeur.
  • Sans annotation de type, c'est l'argument de type SQL qui décide, comme dans Column(String(50)) ou db.Column(db.Numeric).
  • DateTime → 1970-01-01T00:00:00, Date → 1970-01-01, Time → 00:00:00, JSON/JSONB → {}, Uuid → un UUID entièrement à zéro.
  • ARRAY(String) et Mapped[list[str]] deviennent des tableaux d'un élément.
  • Une classe qui étend enum.Enum, utilisée via Enum(Plan) ou Mapped[Plan], fournit la valeur de son premier membre.
  • relationship(), column_property(), les simples variables de classe et les attributs dunder comme __table_args__ sont exclus.
  • Les colonnes des mixins et des modèles parents sont placées avant les colonnes propres de l'enfant.

Cas d'utilisation

Ébaucher un modèle de réponse Pydantic

Avant d'écrire la classe Pydantic du response_model de FastAPI, vérifiez les champs et types que le modèle expose en JSON. Passez ce JSON à la page JSON vers Python pour obtenir aussi une ébauche Pydantic.

Payloads de test pour une API Flask

Construisez le corps de client.post("/subscriptions", json=...) avec des clés qui correspondent aux attributs du modèle. Retirez d'abord l'id auto-incrémenté et la date de création.

Remarques et limites

  • Un default= littéral ("new", 1, True, None) sert de valeur d'exemple ; les callables comme datetime.utcnow ou dict ne sont pas exécutés. server_default= et nullable= ne sont pas lus.
  • Si une colonne reçoit un nom distinct en base, comme dans Column("user_name", String), la clé JSON reste le nom d'attribut Python.
  • Les objets liés chargés via relationship ne sont pas inclus. Ajoutez vous-même les objets imbriqués si votre réponse les embarque.
  • Les attributs calculés comme hybrid_property ou @property ne font pas partie de la sortie.

FAQ

Pourquoi Mapped[Optional[str]] donne-t-il une chaîne vide plutôt que null ?

Optional signifie que None est autorisé ; l'exemple montre le cas où une valeur est présente, et utilise donc le str interne. Remplacez par null dans la sortie si vous avez besoin de ce cas.

Pourquoi les dates-heures n'ont-elles ni Z ni décalage ?

Les colonnes DateTime sont naïves par défaut, et isoformat() les affiche sans décalage. Si vous utilisez DateTime(timezone=True), un exemple avec +00:00 est plus proche de ce que vous verrez réellement.

Peut-il convertir des modèles Django ?

Non. Cette page ne comprend que la syntaxe Column, mapped_column et Mapped de SQLAlchemy ; les champs Django comme models.CharField ne sont pas reconnus.