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

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

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

Lit des modèles Sequelize écrits en JavaScript pur, sequelize.define("User", {...}) ou Model.init({...}, {...}), et les transforme en JSON d'exemple. Faute d'annotations de type, la valeur de chaque attribut est choisie d'après son entrée DataTypes.

Convient aux serveurs Node.js plus anciens tournant sous Express et Sequelize sans TypeScript, où le fichier de modèle est la seule description de l'allure d'une réponse d'API ou d'une ligne de seed.

Mode d'emploi

  1. Collez le fichier de modèle dans le champ Sequelize (JS). Les lignes require et module.exports restantes ne gênent pas.
  2. Si le fichier définit plusieurs modèles, la sortie est indexée par nom de modèle, par exemple { "User": {...}, "Post": {...} }.
  3. Vérifiez que les options du modèle (le second argument) comme timestamps, paranoid ou un createdAt renommé sont bien prises en compte, puis copiez.

Exemple

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

code a primaryKey: true : aucun id n'est donc ajouté, et son defaultValue est DataTypes.UUIDV4, un générateur et non un littéral, d'où l'UUID générique affiché. updatedAt: false laisse createdAt comme seul timestamp, et DATEONLY, TIME, JSONB et ARRAY(STRING) deviennent une chaîne de date, une chaîne d'heure, un objet vide et un tableau d'un élément.

Fonctionnalités prises en charge

  • DataTypes.STRING, TEXT, CHAR → "" ; INTEGER, BIGINT, FLOAT, DECIMAL → 0 ; BOOLEAN → false.
  • DATE donne 1970-01-01T00:00:00.000Z, DATEONLY donne 1970-01-01 et TIME donne 00:00:00.
  • UUID devient une chaîne UUID entièrement à zéro, ENUM("admin", "user") sa première valeur, et JSON/JSONB un objet vide.
  • ARRAY(DataTypes.STRING) suit son type d'élément, et VIRTUAL(DataTypes.STRING) est rempli d'après le type interne.
  • Les options de modèle timestamps: false, updatedAt: false, createdAt: "created_on" et paranoid: true ajoutent, retirent ou renomment les attributs de date.
  • La forme longue { type: ..., allowNull: ... } comme la forme courte DataTypes.X sont comprises.

Cas d'utilisation

Ébaucher des données de seeder

Partez de la sortie pour écrire le tableau d'objets de queryInterface.bulkInsert : noms de clés et types correspondent au modèle. Retirez l'id et les timestamps générés là où la base les remplit.

Lire du code legacy non typé

Sans TypeScript, il est difficile de deviner quel JSON envoie un modèle rien qu'en le lisant. Faire passer chaque fichier de modèle par ici donne une carte rapide des formes de réponse de l'API.

Remarques et limites

  • Un defaultValue littéral ("pending", 1, true) devient la valeur d'exemple. Les valeurs par défaut générées comme DataTypes.NOW, DataTypes.UUIDV4 ou sequelize.fn(...) retombent sur la valeur générique du type.
  • Les associations comme hasMany et belongsTo sont définies hors du modèle et n'apparaissent donc pas dans la sortie. Ajoutez à la main les données chargées avec include.
  • Sur MySQL et PostgreSQL, DECIMAL revient généralement sous forme de chaîne à l'exécution, mais l'exemple affiche 0.
  • Les types sans valeur d'exemple évidente, comme GEOMETRY, deviennent null.

FAQ

J'ai défini underscored: true. Pourquoi est-ce createdAt et non created_at ?

underscored ne change que les noms de colonnes en base vers le snake_case. Les noms d'attributs utilisés par toJSON() restent createdAt : la sortie est donc correcte. Pour changer aussi la clé JSON, nommez-la explicitement avec createdAt: "created_at".

Est-ce que ça marche quand class User extends Model {} et User.init() sont séparés ?

Oui. L'identifiant juste avant .init( sert de nom de modèle, et le premier argument est lu comme la map d'attributs.

Où convertir les modèles TypeScript à décorateurs ?

Utilisez la page Sequelize (TS) vers JSON pour les modèles sequelize-typescript avec @Table et @Column. Cette page lit les types de propriétés au lieu de DataType.