Sequelize-Modelle (JS) in JSON umwandeln!

Gib Sequelize-Modelle (JS) ein, um Beispiel-JSON zu erzeugen! Unterstützt Sequelize define, DataTypes. Praktisch für API-Dokumentation und Test-Request-Bodys (mock request body).
Sequelize (JS)
Ergebnis
 

Sequelize-Modelle (JS) in JSON umwandeln!

Liest Sequelize-Modelle in reinem JavaScript, sequelize.define("User", {...}) oder Model.init({...}, {...}), und macht daraus Beispiel-JSON. Da es keine Typannotationen gibt, wird der Wert jedes Attributs anhand seines DataTypes-Eintrags gewählt.

Das passt zu älteren Node.js-Servern mit Express und Sequelize ohne TypeScript, bei denen die Modelldatei die einzige Beschreibung dafür ist, wie eine API-Antwort oder eine Seed-Zeile aussieht.

So funktioniert es

  1. Füge die Modelldatei in das Feld Sequelize (JS) ein. Übrig gebliebene require-Zeilen und module.exports stören nicht.
  2. Definiert die Datei mehrere Modelle, ist die Ausgabe nach Modellnamen geschlüsselt, z. B. { "User": {...}, "Post": {...} }.
  3. Prüfe, ob die Modelloptionen (das zweite Argument) wie timestamps, paranoid oder ein umbenanntes createdAt berücksichtigt sind, und kopiere dann.

Beispiel

Eingabe (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 }
);
Ausgabe (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 hat primaryKey: true, daher wird kein id ergänzt, und sein defaultValue ist DataTypes.UUIDV4, ein Generator statt eines Literals, weshalb die Platzhalter-UUID angezeigt wird. updatedAt: false lässt createdAt als einzigen Timestamp übrig, und DATEONLY, TIME, JSONB und ARRAY(STRING) werden zu einem Datums-String, einem Zeit-String, einem leeren Objekt und einem Array mit einem Element.

Unterstützte Funktionen

  • DataTypes.STRING, TEXT, CHAR → ""; INTEGER, BIGINT, FLOAT, DECIMAL → 0; BOOLEAN → false.
  • DATE ergibt 1970-01-01T00:00:00.000Z, DATEONLY ergibt 1970-01-01 und TIME ergibt 00:00:00.
  • UUID wird zu einem UUID-String aus lauter Nullen, ENUM("admin", "user") zu seinem ersten Wert und JSON/JSONB zu einem leeren Objekt.
  • ARRAY(DataTypes.STRING) folgt seinem Elementtyp, und VIRTUAL(DataTypes.STRING) wird aus dem inneren Typ befüllt.
  • Die Modelloptionen timestamps: false, updatedAt: false, createdAt: "created_on" und paranoid: true fügen die Datumsattribute hinzu, entfernen oder benennen sie um.
  • Sowohl die lange Form { type: ..., allowNull: ... } als auch die Kurzform DataTypes.X werden verstanden.

Anwendungsfälle

Seeder-Daten entwerfen

Geh von der Ausgabe aus, wenn du das Objekt-Array für queryInterface.bulkInsert schreibst, damit Key-Namen und Typen zum Modell passen. Entferne das erzeugte id und die Timestamps dort, wo die Datenbank sie befüllt.

Untypisierten Legacy-Code lesen

Ohne TypeScript ist es schwer, allein durch Lesen zu erkennen, welches JSON ein Modell sendet. Lässt du jede Modelldatei hier durchlaufen, bekommst du schnell eine Übersicht über die Antwortformen der API.

Hinweise und Einschränkungen

  • Ein literales defaultValue ("pending", 1, true) wird zum Beispielwert. Generierte Standardwerte wie DataTypes.NOW, DataTypes.UUIDV4 oder sequelize.fn(...) fallen auf den Platzhalter des Typs zurück.
  • Assoziationen wie hasMany und belongsTo stehen außerhalb der Modelldefinition und sind daher nicht in der Ausgabe. Daten, die du mit include lädst, ergänzt du von Hand.
  • Auf MySQL und PostgreSQL kommt DECIMAL zur Laufzeit meist als String zurück, das Beispiel zeigt aber 0.
  • Typen ohne naheliegenden Beispielwert wie GEOMETRY werden zu null.

Häufige Fragen

Ich habe underscored: true gesetzt. Warum heißt es createdAt und nicht created_at?

underscored ändert nur die Spaltennamen in der Datenbank auf snake_case. Die Attributnamen, die toJSON() verwendet, bleiben createdAt, die Ausgabe stimmt also. Um auch den JSON-Key zu ändern, benenne ihn explizit mit createdAt: "created_at".

Funktioniert es, wenn class User extends Model {} und User.init() getrennt stehen?

Ja. Der Bezeichner direkt vor .init( wird als Modellname verwendet, und das erste Argument wird als Attribut-Map gelesen.

Wo wandle ich TypeScript-Modelle mit Decorators um?

Für sequelize-typescript-Modelle mit @Table und @Column nimm die Seite Sequelize (TS) zu JSON. Diese Seite liest Property-Typen statt DataType.