Ubah model SQLAlchemy menjadi JSON!

Masukkan model SQLAlchemy untuk membuat contoh JSON! Mendukung SQLAlchemy ORM. Berguna untuk dokumentasi API dan body request uji (mock request body).
SQLAlchemy
Hasil
 

Ubah model SQLAlchemy menjadi JSON!

Tempel class model SQLAlchemy dan dapatkan contoh JSON dengan key berupa nama atribut kolom. Alat ini membaca gaya 2.0 Mapped[...] dengan mapped_column(), gaya 1.x Column(), dan db.Column() dari Flask-SQLAlchemy, serta menggabungkan kolom dari mixin dan class parent.

Model SQLAlchemy tidak bisa langsung diberikan ke json.dumps, jadi aplikasi FastAPI dan Flask menambahkan schema Pydantic atau Marshmallow. Gunakan ini untuk memetakan field apa saja yang akan diekspos model sebelum menulis schema tersebut, atau untuk membuat body request bagi test.

Cara menggunakan

  1. Tempel file model ke kolom SQLAlchemy. Simpan Base, mixin, dan class enum.Enum di input yang sama agar kolom warisan dan nilai enum bisa di-resolve.
  2. Hanya class yang memiliki __tablename__ yang dianggap model. Beberapa model dikeluarkan berdasarkan nama class, seperti { "User": {...}, "Team": {...} }.
  3. Salin hasilnya.

Contoh

Input (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")
Output (JSON)
{
  "created_at": "1970-01-01T00:00:00",
  "id": 0,
  "plan": "free",
  "seats": 1,
  "trial_ends": "1970-01-01",
  "user_id": 0
}

created_at dari TimestampMixin muncul pertama, mengikuti urutan pewarisan, dan user dibuang karena relationship() bukan kolom. db.Enum(Plan) mengambil nilai pertama enum, "free", dan db.Date menjadi 1970-01-01. seats menampilkan 1 dari default=1, sedangkan created_at tetap berisi placeholder karena datetime.utcnow adalah fungsi.

Fitur yang didukung

  • Type hint Python seperti Mapped[int], Mapped[Optional[str]] dan Mapped[str | None] menentukan nilainya.
  • Tanpa type hint, argumen tipe SQL yang menentukan, seperti pada Column(String(50)) atau db.Column(db.Numeric).
  • DateTime → 1970-01-01T00:00:00, Date → 1970-01-01, Time → 00:00:00, JSON/JSONB → {}, Uuid → UUID berisi nol semua.
  • ARRAY(String) dan Mapped[list[str]] menjadi array satu elemen.
  • Class yang meng-extend enum.Enum, dipakai lewat Enum(Plan) atau Mapped[Plan], menyumbangkan nilai member pertamanya.
  • relationship(), column_property(), variabel class biasa, dan atribut dunder seperti __table_args__ dikecualikan.
  • Kolom dari mixin dan model parent ditempatkan sebelum kolom milik class anak.

Kasus penggunaan

Menyusun draf response model Pydantic

Sebelum menulis class Pydantic untuk response_model FastAPI, periksa field dan tipe yang diekspos model sebagai JSON. Masukkan JSON itu ke halaman JSON ke Python untuk sekalian mendapatkan draf Pydantic.

Payload uji untuk API Flask

Bangun body untuk client.post("/subscriptions", json=...) dengan key yang cocok dengan atribut model. Buang dulu id auto-increment dan waktu pembuatannya.

Catatan dan batasan

  • default= berupa literal ("new", 1, True, None) dipakai sebagai nilai contoh; callable seperti datetime.utcnow atau dict tidak dijalankan. server_default= dan nullable= tidak dibaca.
  • Jika kolom diberi nama database terpisah, seperti Column("user_name", String), key JSON tetap nama atribut Python-nya.
  • Objek terkait yang dimuat lewat relationship tidak disertakan. Tambahkan sendiri objek bersarang jika respons Anda menyertakannya.
  • Atribut terhitung seperti hybrid_property atau @property tidak termasuk dalam output.

FAQ

Mengapa Mapped[Optional[str]] berupa string kosong dan bukan null?

Optional berarti None diizinkan; contoh menampilkan kasus ketika nilainya ada, jadi memakai str di dalamnya. Ubah menjadi null di output jika Anda butuh kasus itu.

Mengapa datetime tidak punya Z atau offset?

Kolom DateTime secara default bersifat naive, dan isoformat() mencetaknya tanpa offset. Jika Anda memakai DateTime(timezone=True), contoh dengan +00:00 lebih mendekati apa yang sebenarnya akan Anda lihat.

Apakah bisa mengonversi model Django?

Tidak. Halaman ini hanya memahami sintaks Column, mapped_column dan Mapped milik SQLAlchemy; field Django seperti models.CharField tidak dikenali.