Convertissez des modèles Sequelize (TS) en JSON !

Saisissez des modèles Sequelize (TS) pour générer un JSON d'exemple ! Compatible avec Sequelize, sequelize-typescript. Pratique pour documenter une API et créer des corps de requête de test (mock request body).
Sequelize (TS)
Résultat
 

Convertissez des modèles Sequelize (TS) en JSON !

Donnez-lui des classes de modèle @Table écrites avec sequelize-typescript et il construit un JSON d'exemple ayant la forme de la sortie toJSON() de l'instance. Cela inclut les attributs id, createdAt, updatedAt et deletedAt que Sequelize ajoute même s'ils ne sont pas déclarés dans la classe.

Contrairement à la page JS, les valeurs viennent ici du type TypeScript de chaque propriété plutôt que de l'argument DataType. Un @Column(DataType.DECIMAL) déclaré amount: string produit une chaîne.

Mode d'emploi

  1. Collez un fichier contenant des classes @Table dans le champ Sequelize (TS). Ajoutez les modèles associés (via @HasMany et consorts) pour obtenir des valeurs imbriquées.
  2. Consultez le champ Résultat pour voir le JSON avec les attributs ajoutés automatiquement.
  3. Basculez des options @Table comme timestamps ou paranoid pour voir immédiatement comment les champs de date changent.

Exemple

Entrée (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;
}
Sortie (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
}

La classe n'a pas de clé primaire : id est donc ajouté en premier, et paranoid: true ajoute deletedAt: null. status prend le premier littéral de son union, "draft", et amount est une chaîne vide parce qu'il est déclaré string.

Fonctionnalités prises en charge

  • Sans @PrimaryKey, @Column({ primaryKey: true }) ni propriété id, un id: 0 est inséré en tête, pour la racine comme pour les modèles associés.
  • Sauf si @Table définit timestamps: false, createdAt et updatedAt sont ajoutés à la fin ; les renommages comme createdAt: "created_on", updatedAt: false et paranoid: true (deletedAt: null) sont respectés modèle par modèle.
  • Un Post[] issu de @HasMany devient un tableau ; @BelongsTo et @HasOne deviennent des objets imbriqués.
  • Les unions de littéraux comme "draft" | "sent" utilisent la première valeur, et tout ce qui est hérité via extends Model est ignoré.
  • Une colonne DataType.JSON typée comme un objet, par exemple { theme: string }, est remplie selon cette forme.

Cas d'utilisation

Documenter des handlers Express

Pour des endpoints qui font res.json(await Invoice.findByPk(id)), la sortie fournit un exemple de réponse dont les clés correspondent à la réalité, attributs ajoutés automatiquement compris.

Avant et après l'activation du soft delete

Activer paranoid ajoute deletedAt à chaque réponse. Comparez la sortie avec et sans l'option pour indiquer précisément aux consommateurs de l'API ce qui va changer.

Remarques et limites

  • Les modèles associés imbriqués dans la racine reçoivent leur propre id et leurs timestamps selon leurs propres options @Table, mais les clés étrangères que Sequelize ajoute implicitement (comme invoiceId sur une cible @HasMany sans colonne @ForeignKey) ne sont pas inventées.
  • allowNull et les renommages de colonnes via @Column({ field: ... }) sont ignorés, puisque les clés JSON sont les noms de propriétés. @Default("x") et un defaultValue littéral dans @Column({...}) servent de valeurs d'exemple.
  • underscored: true ne change que les noms de colonnes en base ; toJSON() utilise toujours les noms d'attributs, donc createdAt dans la sortie est correct.
  • Les valeurs viennent des types TypeScript : une propriété typée uniquement via le décorateur (@Column(DataType.INTEGER) count; sans annotation) devient null.

FAQ

Une colonne DECIMAL doit-elle être typée number ou string ?

Avec MySQL et PostgreSQL, Sequelize renvoie par défaut les valeurs DECIMAL sous forme de chaînes. La typer amount: string garde le type honnête, et l'exemple ici affichera aussi une chaîne.

Puis-je utiliser des champs declare ou CreationOptional ?

Oui. declare id: CreationOptional<number> est lu comme number, et le même déballage s'applique à NonAttribute<...> et ForeignKey<...>. Les types utilitaires au-delà de ceux-ci, comme InferAttributes, ne sont pas développés.

Cette page gère-t-elle les modèles sequelize.define écrits en JavaScript ?

Non. Cette page lit des classes et des types TypeScript. Utilisez la page Sequelize (JS) vers JSON pour les modèles define et Model.init, qui lit plutôt DataTypes.