I-convert ang mga Sequelize (JS) model sa JSON!

Maglagay ng mga Sequelize (JS) model para gumawa ng halimbawang JSON! Sinusuportahan ang Sequelize define, DataTypes. Magagamit sa API docs at test request body (mock request body).
Sequelize (JS)
Resulta
 

I-convert ang mga Sequelize (JS) model sa JSON!

Binabasa nito ang mga Sequelize model na isinulat sa plain JavaScript, sequelize.define("User", {...}) o Model.init({...}, {...}), at ginagawa silang halimbawang JSON. Dahil walang type annotation na mapagbabatayan, pinipili ang value ng bawat attribute mula sa entry nito sa DataTypes.

Bagay ito sa mga lumang Node.js server na nagpapatakbo ng Express at Sequelize nang walang TypeScript, kung saan ang model file lang ang naglalarawan sa itsura ng isang API response o seed row.

Paano gamitin

  1. I-paste ang model file sa Sequelize (JS) box. Ayos lang ang mga natirang linyang require at module.exports.
  2. Kung maraming model ang dine-define ng file, naka-key sa model name ang output, hal. { "User": {...}, "Post": {...} }.
  3. I-check na naka-reflect ang mga model option (ang pangalawang argument) gaya ng timestamps, paranoid o pinalitang pangalan ng createdAt, saka kopyahin.

Halimbawa

Input (Sequelize · JavaScript)
class Reservation extends Model {}

Reservation.init(
  {
    code: { type: DataTypes.UUID, defaultValue: DataTypes.UUIDV4, primaryKey: true },
    guests: DataTypes.SMALLINT,
    checkIn: DataTypes.DATEONLY,
    arrivalTime: DataTypes.TIME,
    options: DataTypes.JSONB,
    tags: DataTypes.ARRAY(DataTypes.STRING),
  },
  { sequelize, modelName: "Reservation", updatedAt: false }
);
Output (JSON)
{
  "code": "00000000-0000-0000-0000-000000000000",
  "guests": 0,
  "checkIn": "1970-01-01",
  "arrivalTime": "00:00:00",
  "options": {},
  "tags": [
    ""
  ],
  "createdAt": "1970-01-01T00:00:00.000Z"
}

May primaryKey: true ang code, kaya walang idinadagdag na id, at ang defaultValue nito ay DataTypes.UUIDV4, isang generator at hindi literal, kaya placeholder na UUID ang ipinapakita. Sa updatedAt: false, createdAt na lang ang natitirang timestamp, at nagiging date string, time string, empty object at array na may isang element ang DATEONLY, TIME, JSONB at ARRAY(STRING).

Mga sinusuportahang feature

  • DataTypes.STRING, TEXT, CHAR → ""; INTEGER, BIGINT, FLOAT, DECIMAL → 0; BOOLEAN → false.
  • 1970-01-01T00:00:00.000Z ang ibinibigay ng DATE, 1970-01-01 ang DATEONLY at 00:00:00 ang TIME.
  • Nagiging UUID string na puro zero ang UUID, ang unang value nito ang ENUM("admin", "user"), at empty object ang JSON/JSONB.
  • Sinusunod ng ARRAY(DataTypes.STRING) ang element type nito, at pinupunan mula sa inner type ang VIRTUAL(DataTypes.STRING).
  • Nagdadagdag, nag-aalis o nagpapalit ng pangalan ng mga date attribute ang mga model option na timestamps: false, updatedAt: false, createdAt: "created_on" at paranoid: true.
  • Naiintindihan ang mahabang anyo na { type: ..., allowNull: ... } at ang maikling anyo na DataTypes.X.

Mga gamit

Pag-draft ng seeder data

Magsimula sa output kapag isinusulat ang object array para sa queryInterface.bulkInsert, para tugma sa model ang mga key name at type. Tanggalin ang na-generate na id at timestamps kung saan ang database ang pumupuno sa kanila.

Pagbasa ng untyped na legacy code

Kapag walang TypeScript, mahirap malaman kung anong JSON ang ipinapadala ng isang model sa pagbasa lang. Kapag pinadaan dito ang bawat model file, mabilis kang magkakaroon ng mapa ng mga hugis ng response ng API.

Mga paalala at limitasyon

  • Nagiging sample value ang literal na defaultValue ("pending", 1, true). Bumabalik sa placeholder ng type ang mga generated na default gaya ng DataTypes.NOW, DataTypes.UUIDV4 o sequelize.fn(...).
  • Nasa labas ng model definition ang mga association gaya ng hasMany at belongsTo, kaya wala sila sa output. Mano-manong idagdag ang data na nilo-load mo gamit ang include.
  • Sa MySQL at PostgreSQL, kadalasang bumabalik bilang string ang DECIMAL sa runtime, pero 0 ang ipinapakita ng halimbawa.
  • Nagiging null ang mga type na walang malinaw na sample value, gaya ng GEOMETRY.

Mga madalas itanong

Nag-set ako ng underscored: true. Bakit createdAt at hindi created_at?

Mga database column name lang ang ginagawang snake_case ng underscored. Nananatiling createdAt ang mga attribute name na ginagamit ng toJSON(), kaya tugma ang output. Para palitan din ang JSON key, tahasang pangalanan ito gamit ang createdAt: "created_at".

Gumagana ba ito kapag magkahiwalay ang class User extends Model {} at User.init()?

Oo. Ginagamit bilang model name ang identifier bago mismo ang .init(, at binabasa bilang attribute map ang unang argument.

Saan ko iko-convert ang mga TypeScript decorator model?

Gamitin ang page na Sequelize (TS) to JSON para sa mga sequelize-typescript model na may @Table at @Column. Mga property type ang binabasa ng page na iyon sa halip na DataType.