Преобразуйте модели SQLAlchemy в JSON!

Введите модели SQLAlchemy, чтобы получить пример JSON! Поддержка: SQLAlchemy ORM. Удобно для документации API и тестовых тел запросов (mock request body).
SQLAlchemy
Результат
 

Преобразуйте модели SQLAlchemy в JSON!

Вставьте классы моделей SQLAlchemy и получите пример JSON с ключами по именам атрибутов-колонок. Понимает Mapped[...] с mapped_column() в стиле 2.0, Column() в стиле 1.x и db.Column() из Flask-SQLAlchemy, а также подмешивает колонки из миксинов и родительских классов.

Модели SQLAlchemy нельзя передать в json.dumps напрямую, поэтому приложения на FastAPI и Flask добавляют схемы Pydantic или Marshmallow. Используйте эту страницу, чтобы до написания такой схемы разложить, какие поля модель будет отдавать, или чтобы собрать тела запросов для тестов.

Как пользоваться

  1. Вставьте файл модели в поле SQLAlchemy. Держите Base, миксины и классы enum.Enum в том же вводе, чтобы унаследованные колонки и значения enum разрешились.
  2. Моделями считаются только классы с __tablename__. Несколько моделей выводятся по именам классов, вроде { "User": {...}, "Team": {...} }.
  3. Скопируйте результат.

Пример

Вход (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")
Результат (JSON)
{
  "created_at": "1970-01-01T00:00:00",
  "id": 0,
  "plan": "free",
  "seats": 1,
  "trial_ends": "1970-01-01",
  "user_id": 0
}

created_at из TimestampMixin идёт первым в порядке наследования, а user отброшен, потому что relationship() — не колонка. db.Enum(Plan) берёт первое значение enum, "free", а db.Date становится 1970-01-01. seats показывает 1 из default=1, а created_at сохраняет заглушку, потому что datetime.utcnow — функция.

Возможности

  • Значение определяется аннотациями типов Python вроде Mapped[int], Mapped[Optional[str]] и Mapped[str | None].
  • Без аннотации типа решает аргумент SQL-типа, как в Column(String(50)) или db.Column(db.Numeric).
  • DateTime → 1970-01-01T00:00:00, Date → 1970-01-01, Time → 00:00:00, JSON/JSONB → {}, Uuid → UUID из одних нулей.
  • ARRAY(String) и Mapped[list[str]] становятся массивами из одного элемента.
  • Класс, наследующий enum.Enum и используемый через Enum(Plan) или Mapped[Plan], даёт значение своего первого члена.
  • relationship(), column_property(), обычные переменные класса и dunder-атрибуты вроде __table_args__ исключаются.
  • Колонки из миксинов и родительских моделей ставятся перед собственными колонками дочерней модели.

Сценарии использования

Черновик модели ответа Pydantic

Прежде чем писать класс Pydantic для response_model в FastAPI, проверьте, какие поля и типы модель отдаёт в JSON. Подайте этот JSON на страницу JSON в Python — и получите ещё и черновик на Pydantic.

Тестовые payload для Flask API

Соберите тело для client.post("/subscriptions", json=...) с ключами, совпадающими с атрибутами модели. Сначала уберите автоинкрементный id и время создания.

Примечания и ограничения

  • Литеральный default= ("new", 1, True, None) используется как значение примера; вызываемые объекты вроде datetime.utcnow или dict не выполняются. server_default= и nullable= не читаются.
  • Если колонке задано отдельное имя в базе, как в Column("user_name", String), ключ JSON всё равно остаётся именем атрибута Python.
  • Связанные объекты, загружаемые через relationship, не включаются. Если ваш ответ их встраивает, добавьте вложенные объекты сами.
  • Вычисляемые атрибуты вроде hybrid_property или @property в вывод не входят.

Частые вопросы

Почему Mapped[Optional[str]] — пустая строка, а не null?

Optional означает, что None допустим; пример показывает случай, когда значение есть, поэтому используется внутренний str. Если нужен именно этот случай, поменяйте значение на null в выводе.

Почему у дат-времени нет Z или смещения?

Колонки DateTime по умолчанию naive, и isoformat() выводит их без смещения. Если вы используете DateTime(timezone=True), ближе к реальности будет пример с +00:00.

Может ли он преобразовать модели Django?

Нет. Эта страница понимает только синтаксис SQLAlchemy — Column, mapped_column и Mapped; поля Django вроде models.CharField не распознаются.