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

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

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

Подайте классы моделей @Table, написанные с sequelize-typescript, — и он построит пример JSON в форме вывода toJSON() экземпляра. Сюда входят атрибуты id, createdAt, updatedAt и deletedAt, которые Sequelize добавляет, даже если они не объявлены в классе.

В отличие от JS-страницы, значения здесь берутся из TypeScript-типа каждого свойства, а не из аргумента DataType. @Column(DataType.DECIMAL), объявленный как amount: string, даёт строку.

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

  1. Вставьте файл с классами @Table в поле Sequelize (TS). Добавьте связанные модели (через @HasMany и подобные), чтобы получить вложенные значения.
  2. Посмотрите в поле Результат JSON с автоматически добавленными атрибутами.
  3. Переключайте опции @Table, такие как timestamps или paranoid, чтобы сразу увидеть, как меняются поля дат.

Пример

Вход (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;
}
Результат (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
}

У класса нет первичного ключа, поэтому первым добавляется id, а paranoid: true добавляет deletedAt: null. status берёт первый литерал своего union — "draft", а amount — пустая строка, потому что объявлен как string.

Возможности

  • Без @PrimaryKey, @Column({ primaryKey: true }) или свойства id в начало вставляется id: 0 — и для корня, и для связанных моделей.
  • Если @Table не задаёт timestamps: false, добавляются createdAt и updatedAt; переименования вроде createdAt: "created_on", updatedAt: false и paranoid: true (deletedAt: null) учитываются для каждой модели отдельно.
  • Post[] из @HasMany становится массивом; @BelongsTo и @HasOne — вложенными объектами.
  • Union литералов вроде "draft" | "sent" использует первое значение, а всё, унаследованное через extends Model, игнорируется.
  • Колонка DataType.JSON с объектным типом, например { theme: string }, заполняется в этой форме.

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

Документирование обработчиков Express

Для эндпоинтов, делающих res.json(await Invoice.findByPk(id)), вывод даёт пример ответа, ключи которого совпадают с реальностью, включая автоматически добавленные атрибуты.

До и после включения мягкого удаления

Включение paranoid добавляет deletedAt в каждый ответ. Сравните вывод с опцией и без неё, чтобы точно сообщить потребителям API, что изменится.

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

  • Связанные модели, вложенные в корень, получают собственные id и метки времени по своим опциям @Table, но внешние ключи, которые Sequelize добавляет неявно (например, invoiceId у цели @HasMany без колонки @ForeignKey), не выдумываются.
  • allowNull и переименования колонок через @Column({ field: ... }) игнорируются, поскольку ключи JSON — это имена свойств. @Default("x") и литеральный defaultValue в @Column({...}) используются как значения примера.
  • underscored: true меняет только имена колонок в базе; toJSON() по-прежнему использует имена атрибутов, так что createdAt в выводе верен.
  • Значения берутся из типов TypeScript, поэтому свойство, тип которого задан только через декоратор (@Column(DataType.INTEGER) count; без аннотации), становится null.

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

Типизировать колонку DECIMAL как number или string?

С MySQL и PostgreSQL Sequelize по умолчанию возвращает значения DECIMAL строками. Тип amount: string честно это отражает, и пример здесь тоже покажет строку.

Можно ли использовать поля declare или CreationOptional?

Да. declare id: CreationOptional<number> читается как number, и так же разворачиваются NonAttribute<...> и ForeignKey<...>. Другие вспомогательные типы, вроде InferAttributes, не раскрываются.

Обрабатывает ли эта страница модели sequelize.define, написанные на JavaScript?

Нет. Эта страница читает классы и типы TypeScript. Для моделей define и Model.init используйте страницу Sequelize (JS) в JSON — она читает DataTypes.