Chuyển model SQLAlchemy thành JSON!

Nhập model SQLAlchemy để tạo JSON mẫu! Hỗ trợ SQLAlchemy ORM. Hữu ích cho tài liệu API và request body thử nghiệm (mock request body).
SQLAlchemy
Kết quả
 

Chuyển model SQLAlchemy thành JSON!

Dán các class model SQLAlchemy để nhận JSON ví dụ với key là tên attribute của cột. Công cụ đọc Mapped[...] kiểu 2.0 với mapped_column(), Column() kiểu 1.x, và db.Column() của Flask-SQLAlchemy, đồng thời gộp vào các cột từ mixin và class cha.

Model SQLAlchemy không truyền thẳng vào json.dumps được, nên app FastAPI và Flask thêm schema Pydantic hoặc Marshmallow. Hãy dùng công cụ này để bày ra các field mà model sẽ lộ ra trước khi viết schema đó, hoặc để dựng body request cho test.

Cách sử dụng

  1. Dán file model vào ô SQLAlchemy. Giữ Base, mixin và class enum.Enum trong cùng đầu vào để cột kế thừa và giá trị enum được phân giải.
  2. Chỉ class có __tablename__ mới được tính là model. Nhiều model được xuất theo tên class, như { "User": {...}, "Team": {...} }.
  3. Sao chép kết quả.

Ví dụ

Đầu vào (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")
Đầu ra (JSON)
{
  "created_at": "1970-01-01T00:00:00",
  "id": 0,
  "plan": "free",
  "seats": 1,
  "trial_ends": "1970-01-01",
  "user_id": 0
}

created_at từ TimestampMixin đứng đầu theo thứ tự kế thừa, và user bị bỏ vì relationship() không phải cột. db.Enum(Plan) lấy giá trị đầu tiên của enum, "free", và db.Date thành 1970-01-01. seats hiện 1 từ default=1, còn created_at giữ giá trị giữ chỗ vì datetime.utcnow là một hàm.

Tính năng hỗ trợ

  • Type hint Python như Mapped[int], Mapped[Optional[str]] và Mapped[str | None] quyết định giá trị.
  • Khi không có type hint, tham số kiểu SQL quyết định, như trong Column(String(50)) hay db.Column(db.Numeric).
  • DateTime → 1970-01-01T00:00:00, Date → 1970-01-01, Time → 00:00:00, JSON/JSONB → {}, Uuid → UUID toàn số 0.
  • ARRAY(String) và Mapped[list[str]] thành mảng một phần tử.
  • Class kế thừa enum.Enum, được dùng qua Enum(Plan) hoặc Mapped[Plan], đóng góp giá trị của member đầu tiên.
  • relationship(), column_property(), biến class thông thường và attribute dunder như __table_args__ bị loại.
  • Cột từ mixin và model cha được đặt trước các cột riêng của class con.

Trường hợp sử dụng

Soạn response model Pydantic

Trước khi viết class Pydantic cho response_model của FastAPI, hãy kiểm tra các field và kiểu mà model lộ ra dưới dạng JSON. Đưa JSON đó vào trang JSON to Python là có luôn bản nháp Pydantic.

Payload test cho API Flask

Dựng body cho client.post("/subscriptions", json=...) với key khớp attribute của model. Bỏ id tự tăng và thời điểm tạo trước.

Lưu ý và giới hạn

  • default= dạng literal ("new", 1, True, None) được dùng làm giá trị mẫu; callable như datetime.utcnow hay dict không được chạy. server_default= và nullable= không được đọc.
  • Nếu cột được đặt tên riêng trong database, như Column("user_name", String), key JSON vẫn là tên attribute Python.
  • Object liên quan được nạp qua relationship không được đưa vào. Hãy tự thêm object lồng nhau nếu response của bạn nhúng chúng.
  • Attribute tính toán như hybrid_property hay @property không nằm trong output.

Câu hỏi thường gặp

Vì sao Mapped[Optional[str]] là chuỗi rỗng chứ không phải null?

Optional nghĩa là cho phép None; ví dụ hiển thị trường hợp có giá trị, nên dùng str bên trong. Hãy đổi thành null trong output nếu bạn cần trường hợp đó.

Vì sao ngày giờ không có Z hay offset?

Cột DateTime mặc định là naive, và isoformat() in chúng ra không kèm offset. Nếu bạn dùng DateTime(timezone=True), ví dụ có +00:00 sẽ gần với những gì bạn thực sự thấy hơn.

Có chuyển được model Django không?

Không. Trang này chỉ hiểu cú pháp Column, mapped_column và Mapped của SQLAlchemy; field Django như models.CharField không được nhận ra.