Tukar model SQLAlchemy kepada JSON!

Masukkan model SQLAlchemy untuk menjana contoh JSON! Menyokong SQLAlchemy ORM. Berguna untuk dokumentasi API dan badan permintaan ujian (mock request body).
SQLAlchemy
Hasil
 

Tukar model SQLAlchemy kepada JSON!

Tampal kelas model SQLAlchemy dan dapatkan contoh JSON yang dikunci mengikut nama atribut lajur. Ia membaca Mapped[...] gaya 2.0 dengan mapped_column(), Column() gaya 1.x, dan db.Column() Flask-SQLAlchemy, serta menggabungkan lajur daripada mixin dan kelas induk.

Model SQLAlchemy tidak boleh dihantar terus kepada json.dumps, jadi aplikasi FastAPI dan Flask menambah skema Pydantic atau Marshmallow. Gunakan alat ini untuk merangka medan yang akan didedahkan oleh model sebelum menulis skema tersebut, atau untuk membina body request bagi ujian.

Cara menggunakan

  1. Tampal fail model ke dalam kotak SQLAlchemy. Simpan Base, mixin dan kelas enum.Enum dalam input yang sama supaya lajur yang diwarisi dan nilai enum dapat dileraikan.
  2. Hanya kelas dengan __tablename__ dikira sebagai model. Beberapa model dikeluarkan mengikut nama kelas, 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 daripada TimestampMixin diletakkan dahulu mengikut susunan pewarisan, dan user digugurkan kerana relationship() bukan lajur. db.Enum(Plan) mengambil nilai pertama enum, "free", dan db.Date menjadi 1970-01-01. seats menunjukkan 1 daripada default=1, manakala created_at mengekalkan placeholder kerana datetime.utcnow ialah fungsi.

Ciri yang disokong

  • Type hint Python seperti Mapped[int], Mapped[Optional[str]] dan Mapped[str | None] menentukan nilai.
  • Tanpa type hint, argumen jenis SQL yang menentukan, seperti dalam 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 serba sifar.
  • ARRAY(String) dan Mapped[list[str]] menjadi array satu elemen.
  • Kelas yang mewarisi enum.Enum, digunakan melalui Enum(Plan) atau Mapped[Plan], menyumbang nilai ahli pertamanya.
  • relationship(), column_property(), pemboleh ubah kelas biasa dan atribut dunder seperti __table_args__ dikecualikan.
  • Lajur daripada mixin dan model induk diletakkan sebelum lajur milik kelas anak itu sendiri.

Kes penggunaan

Mendraf model respons Pydantic

Sebelum menulis kelas Pydantic untuk response_model FastAPI, semak medan dan jenis yang didedahkan oleh model sebagai JSON. Masukkan JSON itu ke halaman JSON ke Python untuk mendapatkan draf Pydantic juga.

Payload ujian untuk API Flask

Bina body untuk client.post("/subscriptions", json=...) dengan kunci yang sepadan dengan atribut model. Buang dahulu id autoincrement dan masa penciptaan.

Nota dan had

  • default= literal ("new", 1, True, None) digunakan sebagai nilai contoh; callable seperti datetime.utcnow atau dict tidak dijalankan. server_default= dan nullable= tidak dibaca.
  • Jika lajur diberi nama pangkalan data berasingan, seperti dalam Column("user_name", String), kunci JSON tetap nama atribut Python.
  • Objek berkaitan yang dimuatkan melalui relationship tidak disertakan. Tambah sendiri objek bersarang jika respons anda membenamkannya.
  • Atribut terkira seperti hybrid_property atau @property bukan sebahagian daripada output.

Soalan lazim

Kenapa Mapped[Optional[str]] menjadi rentetan kosong dan bukan null?

Optional bermakna None dibenarkan; contoh ini menunjukkan kes apabila nilai wujud, jadi ia menggunakan str dalaman. Tukar kepada null dalam output jika anda memerlukan kes itu.

Kenapa datetime tiada Z atau offset?

Lajur DateTime adalah naive secara lalai, dan isoformat() mencetaknya tanpa offset. Jika anda menggunakan DateTime(timezone=True), contoh dengan +00:00 lebih hampir kepada apa yang anda akan lihat sebenarnya.

Bolehkah ia menukar model Django?

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