Преобразуйте сущности TypeORM в JSON!

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

Преобразуйте сущности TypeORM в JSON!

Вставьте классы сущностей TypeORM и получите форму JSON, которую эти сущности дают, когда вы возвращаете их из API, заполненную значениями-заглушками. Рассчитано на проекты на NestJS или Express, которые отдают сущности прямо в ответах, и когда нужны примеры для Swagger или образцы запросов/ответов для согласования с фронтендом.

Значения берутся из TypeScript-типа каждого свойства, а не из опций @Column. Поэтому колонка, объявленная как @Column({ type: "decimal" }) с price: number, выводится как число 0.

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

  1. Вставьте файл сущности в поле TypeORM. Включите связанные сущности и enum, чтобы вложенные объекты были заполнены.
  2. Содержимое поля Результат меняется прямо во время ввода. Сущность, на которую не ссылается ни одна другая, становится объектом JSON верхнего уровня; если несвязанных сущностей несколько, каждая выводится под именем своего класса.
  3. Заберите JSON кнопкой копирования в правом верхнем углу результата или нажмите Ctrl/⌘+Enter.

Пример

Вход (TypeORM)
enum Genre { Novel = "novel", Essay = "essay" }

@Entity()
export class Author {
  @PrimaryGeneratedColumn()
  id: number;

  @Column()
  name: string;
}

@Entity()
export class Book {
  @PrimaryGeneratedColumn("uuid")
  id: string;

  @Column({ type: "enum", enum: Genre })
  genre: Genre;

  @Column({ type: "decimal", nullable: true })
  price: number | null;

  @ManyToOne(() => Author)
  author: Author;

  @Exclude()
  @Column()
  internalCode: string;
}
Результат (JSON)
{
  "id": "",
  "genre": "novel",
  "price": 0,
  "author": {
    "id": 0,
    "name": ""
  }
}

Book ссылается на Author, поэтому корень — Book, а author вложен в него. internalCode отброшен из-за @Exclude(), а price с типом number | null следует первому не-null типу и становится 0. Первичный ключ uuid имеет тип string, поэтому это пустая строка.

Возможности

  • Связи @ManyToOne и @OneToOne становятся вложенными объектами; Post[] из @OneToMany или @ManyToMany — массивом из одного элемента.
  • Ленивые связи (Promise<Post[]>) и ESM-обёртка Relation<User> разворачиваются до внутреннего типа.
  • Enum TypeScript используют значение первого члена: строку для строковых enum, число для числовых.
  • Поля с @Exclude() из class-transformer, поля static, методы и геттеры не выводятся.
  • Свойства Date (из @CreateDateColumn и подобных) становятся ISO-строками вида 1970-01-01T00:00:00.000Z.
  • Типы, типичные для колонок jsonb, такие как Record<string, number>, показываются как {"key": 0}.
  • Когда сущности ссылаются друг на друга, повторный заход обрывается на null или пустом массиве, так что вложенность остаётся конечной.

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

Примеры Swagger в контроллерах NestJS

Контроллерам, которые возвращают сущности напрямую, всё равно нужен пример payload для @ApiResponse. Вставьте файл сущности и замените значения-заглушки в результате реалистичными.

Предпросмотр загруженных связей

Когда вы делаете запрос с relations: ["author"], фронтенду нужно знать, насколько глубоко вложен ответ. Вывод наглядно показывает, какие поля связей — объекты, а какие — массивы.

Фикстуры для e2e-тестов

Используйте вывод как каркас тела запроса для POST-вызовов через supertest. Удалите генерируемые поля вроде id и меток времени, затем заполните остальное.

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

  • Опции @Column вроде nullable, default или length не читаются; значение берётся из типа свойства или литерального инициализатора (status = "draft"). Если колонка может быть null, поменяйте значение на null сами.
  • Несколько классов @Entity, не ссылающихся друг на друга, преобразуются все, с ключами по именам классов ({ "Book": {...}, "Author": {...} }). Сущности, ссылающиеся друг на друга, по-прежнему дают один вложенный корень.
  • Классы, которые импортируются, а не вставлены, инструменту неизвестны и отображаются как null.
  • @Expose, группы сериализации и @Transform, используемые с ClassSerializerInterceptor, не применяются.

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

Почему мой @PrimaryGeneratedColumn("uuid") — пустая строка?

Значение определяет только тип свойства. id: string даёт ""; аргумент "uuid" в декораторе не читается. Для документации потом подставьте значение в форме UUID.

Действительно ли мой API возвращает именно это, отдавая сущность?

Это совпадает с JSON.stringify полностью загруженной сущности. Связей, которые вы не загрузили через relations, в реальном ответе просто нет, так что считайте поля связей в выводе загруженным случаем.

Колонка decimal показывает число, а мой API возвращает строку. Почему?

Драйверы PostgreSQL и MySQL возвращают значения decimal строками, чтобы не терять точность. Объявите в сущности свойство как price: string — и вывод, как и ваши реальные данные, будет строкой.