Преобразуйте модели Sequelize (JS) в JSON!

Введите модели Sequelize (JS), чтобы получить пример JSON! Поддержка: Sequelize define, DataTypes. Удобно для документации API и тестовых тел запросов (mock request body).
Sequelize (JS)
Результат
 

Преобразуйте модели Sequelize (JS) в JSON!

Читает модели Sequelize на чистом JavaScript — sequelize.define("User", {...}) или Model.init({...}, {...}) — и превращает их в пример JSON. Поскольку аннотаций типов нет, значение каждого атрибута выбирается по его записи DataTypes.

Подходит для старых серверов на Node.js с Express и Sequelize без TypeScript, где файл модели — единственное описание того, как выглядит ответ API или строка seed-данных.

Как пользоваться

  1. Вставьте файл модели в поле Sequelize (JS). Оставшиеся строки require и module.exports не мешают.
  2. Если в файле определено несколько моделей, вывод разбивается по именам моделей, например { "User": {...}, "Post": {...} }.
  3. Убедитесь, что опции модели (второй аргумент), такие как timestamps, paranoid или переименованный createdAt, учтены, и скопируйте.

Пример

Вход (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 }
);
Результат (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 стоит primaryKey: true, поэтому id не добавляется, а его defaultValue — DataTypes.UUIDV4, генератор, а не литерал, поэтому показан UUID-заглушка. updatedAt: false оставляет createdAt единственной меткой времени, а DATEONLY, TIME, JSONB и ARRAY(STRING) становятся строкой даты, строкой времени, пустым объектом и массивом из одного элемента.

Возможности

  • DataTypes.STRING, TEXT, CHAR → ""; INTEGER, BIGINT, FLOAT, DECIMAL → 0; BOOLEAN → false.
  • DATE даёт 1970-01-01T00:00:00.000Z, DATEONLY — 1970-01-01, а TIME — 00:00:00.
  • UUID становится строкой UUID из одних нулей, ENUM("admin", "user") — своим первым значением, а JSON/JSONB — пустым объектом.
  • ARRAY(DataTypes.STRING) следует типу элемента, а VIRTUAL(DataTypes.STRING) заполняется по внутреннему типу.
  • Опции модели timestamps: false, updatedAt: false, createdAt: "created_on" и paranoid: true добавляют, убирают или переименовывают атрибуты дат.
  • Понимаются и длинная форма { type: ..., allowNull: ... }, и короткая DataTypes.X.

Сценарии использования

Черновик данных для сидеров

Начните с вывода, когда пишете массив объектов для queryInterface.bulkInsert, — тогда имена ключей и типы совпадут с моделью. Уберите сгенерированные id и метки времени там, где их заполняет база.

Чтение нетипизированного legacy-кода

Без TypeScript трудно понять, какой JSON отдаёт модель, просто читая её. Прогон каждого файла модели через эту страницу быстро даёт карту форм ответов API.

Примечания и ограничения

  • Литеральный defaultValue ("pending", 1, true) становится значением примера. Генерируемые значения по умолчанию вроде DataTypes.NOW, DataTypes.UUIDV4 или sequelize.fn(...) заменяются заглушкой по типу.
  • Связи вроде hasMany и belongsTo находятся вне определения модели, поэтому в вывод не попадают. Данные, загружаемые через include, добавьте вручную.
  • В MySQL и PostgreSQL DECIMAL во время выполнения обычно возвращается строкой, но пример показывает 0.
  • Типы без очевидного значения примера, такие как GEOMETRY, становятся null.

Частые вопросы

Я задал underscored: true. Почему createdAt, а не created_at?

underscored меняет на snake_case только имена колонок в базе. Имена атрибутов, которые использует toJSON(), остаются createdAt, так что вывод верен. Чтобы поменять и ключ JSON, задайте имя явно через createdAt: "created_at".

Работает ли это, когда class User extends Model {} и User.init() разнесены?

Да. Идентификатор прямо перед .init( используется как имя модели, а первый аргумент читается как карта атрибутов.

Где преобразовывать модели на TypeScript-декораторах?

Для моделей sequelize-typescript с @Table и @Column используйте страницу Sequelize (TS) в JSON. Она читает типы свойств, а не DataType.