Converta modelos SQLAlchemy em JSON!

Insira modelos SQLAlchemy para gerar JSON de exemplo! Compatível com SQLAlchemy ORM. Útil para documentar APIs e corpos de requisição de teste (mock request body).
SQLAlchemy
Resultado
 

Converta modelos SQLAlchemy em JSON!

Cole classes de model do SQLAlchemy e receba um JSON de exemplo com os nomes dos atributos de coluna como chaves. Ele lê o estilo 2.0 com Mapped[...] e mapped_column(), o estilo 1.x com Column() e o db.Column() do Flask-SQLAlchemy, e mescla as colunas de mixins e classes pai.

Models do SQLAlchemy não podem ser passados direto para json.dumps, então apps FastAPI e Flask adicionam schemas Pydantic ou Marshmallow. Use isto para mapear quais campos um model vai expor antes de escrever esse schema, ou para montar request bodies para testes.

Como usar

  1. Cole o arquivo de model na caixa SQLAlchemy. Mantenha Base, mixins e classes enum.Enum na mesma entrada para que as colunas herdadas e os valores de enum sejam resolvidos.
  2. Só classes com __tablename__ contam como models. Vários models saem organizados por nome de classe, como { "User": {...}, "Team": {...} }.
  3. Copie o resultado.

Exemplo

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")
Saída (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 vem primeiro, seguindo a ordem de herança, e user é descartado porque relationship() não é coluna. db.Enum(Plan) usa o primeiro valor do enum, "free", e db.Date vira 1970-01-01. seats mostra 1 por causa do default=1, enquanto created_at mantém o placeholder porque datetime.utcnow é uma função.

Recursos suportados

  • Type hints Python como Mapped[int], Mapped[Optional[str]] e Mapped[str | None] decidem o valor.
  • Sem type hint, quem decide é o argumento de tipo SQL, como em 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 → um UUID todo zerado.
  • ARRAY(String) e Mapped[list[str]] viram arrays de um elemento.
  • Uma classe que estende enum.Enum, usada via Enum(Plan) ou Mapped[Plan], contribui com o valor do seu primeiro membro.
  • relationship(), column_property(), variáveis de classe simples e atributos dunder como __table_args__ são excluídos.
  • Colunas de mixins e models pai são colocadas antes das colunas próprias da classe filha.

Casos de uso

Rascunhar um response model Pydantic

Antes de escrever a classe Pydantic para o response_model do FastAPI, confira os campos e tipos que o model expõe como JSON. Passe esse JSON para a página JSON para Python e obtenha também um rascunho em Pydantic.

Payloads de teste para uma API Flask

Monte o body para client.post("/subscriptions", json=...) com chaves que batem com os atributos do model. Tire antes o id autoincrement e o horário de criação.

Observações e limitações

  • Um default= literal ("new", 1, True, None) é usado como valor de exemplo; callables como datetime.utcnow ou dict não são executados. server_default= e nullable= não são lidos.
  • Se uma coluna recebe um nome separado no banco, como em Column("user_name", String), a chave JSON continua sendo o nome do atributo Python.
  • Objetos relacionados carregados via relationship não são incluídos. Adicione você mesmo os objetos aninhados se a sua resposta os incorpora.
  • Atributos calculados como hybrid_property ou @property não fazem parte da saída.

Perguntas frequentes

Por que Mapped[Optional[str]] é uma string vazia em vez de null?

Optional significa que None é permitido; o exemplo mostra o caso em que há valor, então usa o str interno. Troque por null na saída se precisar desse caso.

Por que os datetimes não têm Z nem offset?

Colunas DateTime são naive por padrão, e o isoformat() as imprime sem offset. Se você usa DateTime(timezone=True), um exemplo com +00:00 fica mais próximo do que você vai realmente ver.

Ele converte models do Django?

Não. Esta página só entende a sintaxe Column, mapped_column e Mapped do SQLAlchemy; campos do Django como models.CharField não são reconhecidos.