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

Maglagay ng mga Sequelize (TS) model para gumawa ng halimbawang JSON! Sinusuportahan ang Sequelize, sequelize-typescript. Magagamit sa API docs at test request body (mock request body).
Sequelize (TS)
Resulta
 

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

Bigyan ito ng mga @Table model class na isinulat gamit ang sequelize-typescript at bubuo ito ng halimbawang JSON na hugis ng toJSON() output ng instance. Kasama rito ang mga attribute na id, createdAt, updatedAt at deletedAt na idinadagdag ng Sequelize kahit hindi sila naka-declare sa class.

Hindi tulad ng JS page, galing dito ang mga value sa TypeScript type ng bawat property sa halip na sa argument ng DataType. Gumagawa ng string ang @Column(DataType.DECIMAL) na naka-declare bilang amount: string.

Paano gamitin

  1. I-paste sa Sequelize (TS) box ang file na may mga @Table class. Idagdag ang mga associated model (gamit ang @HasMany at mga katulad) para makakuha ng mga nested value.
  2. Tingnan sa Resulta box ang JSON kasama ang mga awtomatikong idinagdag na attribute.
  3. Palipat-lipatin ang mga @Table option gaya ng timestamps o paranoid para agad na makita kung paano nagbabago ang mga date field.

Halimbawa

Input (sequelize-typescript)
@Table({ tableName: "invoices", paranoid: true })
export class Invoice extends Model {
  @Column(DataType.STRING(20))
  number: string;

  @Column(DataType.DECIMAL(10, 2))
  amount: string;

  @Column(DataType.ENUM("draft", "sent", "paid"))
  status: "draft" | "sent" | "paid";

  @ForeignKey(() => Customer)
  @Column
  customerId: number;
}
Output (JSON)
{
  "id": 0,
  "number": "",
  "amount": "",
  "status": "draft",
  "customerId": 0,
  "createdAt": "1970-01-01T00:00:00.000Z",
  "updatedAt": "1970-01-01T00:00:00.000Z",
  "deletedAt": null
}

Walang primary key ang class, kaya idinadagdag sa unahan ang id, at nagdadagdag ng deletedAt: null ang paranoid: true. Kinukuha ng status ang unang literal ng union nito, "draft", at empty string ang amount dahil naka-declare ito bilang string.

Mga sinusuportahang feature

  • Kapag walang @PrimaryKey, @Column({ primaryKey: true }) o id property, isinisingit ang id: 0 sa itaas, para sa root at sa mga associated model.
  • Maliban kung nag-set ang @Table ng timestamps: false, idinadagdag ang createdAt at updatedAt; sinusunod bawat model ang mga rename gaya ng createdAt: "created_on", updatedAt: false at paranoid: true (deletedAt: null).
  • Nagiging array ang Post[] mula sa @HasMany; nagiging nested object ang @BelongsTo at @HasOne.
  • Ginagamit ng mga literal union gaya ng "draft" | "sent" ang unang value, at hindi pinapansin ang lahat ng minana sa pamamagitan ng extends Model.
  • Pinupunan sa hugis na iyon ang DataType.JSON column na may object type, hal. { theme: string }.

Mga gamit

Pagdodokumento ng mga Express handler

Para sa mga endpoint na gumagawa ng res.json(await Invoice.findByPk(id)), nagbibigay ang output ng response example na tugma sa totoo ang mga key, kasama ang mga awtomatikong idinagdag na attribute.

Bago at pagkatapos i-enable ang soft delete

Kapag in-on ang paranoid, nadadagdagan ng deletedAt ang bawat response. Ikumpara ang output na naka-on at naka-off ang option para masabi nang eksakto sa mga API consumer kung ano ang magbabago.

Mga paalala at limitasyon

  • Nakakakuha ng sariling id at timestamps mula sa sarili nilang @Table option ang mga associated model na naka-nest sa loob ng root, pero hindi iniimbento ang mga foreign key na implicit na idinadagdag ng Sequelize (gaya ng invoiceId sa isang @HasMany target na walang @ForeignKey column).
  • Hindi pinapansin ang allowNull at ang pagpapalit ng column name gamit ang @Column({ field: ... }), dahil mga property name ang mga JSON key. Ginagamit bilang sample value ang @Default("x") at ang literal na defaultValue sa @Column({...}).
  • Mga database column name lang ang binabago ng underscored: true; attribute name pa rin ang gamit ng toJSON(), kaya tama ang createdAt sa output.
  • Galing sa mga TypeScript type ang mga value, kaya nagiging null ang property na may type lang sa pamamagitan ng decorator (@Column(DataType.INTEGER) count; na walang annotation).

Mga madalas itanong

Dapat bang number o string ang type ng isang DECIMAL column?

Sa MySQL at PostgreSQL, ibinabalik ng Sequelize ang mga DECIMAL value bilang string bilang default. Kapag amount: string ang type, tapat ang type, at string din ang ipapakita ng halimbawa rito.

Puwede ko bang gamitin ang mga declare field o CreationOptional?

Oo. Binabasa bilang number ang declare id: CreationOptional<number>, at ganoon ding pag-unwrap ang ina-apply sa NonAttribute<...> at ForeignKey<...>. Hindi pinapalawak ang mga helper type na lampas dito, gaya ng InferAttributes.

Kaya ba ng page na ito ang mga sequelize.define model na isinulat sa JavaScript?

Hindi. Mga class at TypeScript type ang binabasa ng page na ito. Gamitin ang page na Sequelize (JS) to JSON para sa mga define at Model.init model, na DataTypes ang binabasa.