Вставьте классы сущностей TypeORM и получите форму JSON, которую эти сущности дают, когда вы возвращаете их из API, заполненную значениями-заглушками. Рассчитано на проекты на NestJS или Express, которые отдают сущности прямо в ответах, и когда нужны примеры для Swagger или образцы запросов/ответов для согласования с фронтендом.
Значения берутся из TypeScript-типа каждого свойства, а не из опций @Column. Поэтому колонка, объявленная как @Column({ type: "decimal" }) с price: number, выводится как число 0.
TypeORM. Включите связанные сущности и enum, чтобы вложенные объекты были заполнены.Результат меняется прямо во время ввода. Сущность, на которую не ссылается ни одна другая, становится объектом JSON верхнего уровня; если несвязанных сущностей несколько, каждая выводится под именем своего класса.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;
}{
"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> разворачиваются до внутреннего типа.@Exclude() из class-transformer, поля static, методы и геттеры не выводятся.Date (из @CreateDateColumn и подобных) становятся ISO-строками вида 1970-01-01T00:00:00.000Z.Record<string, number>, показываются как {"key": 0}.null или пустом массиве, так что вложенность остаётся конечной.Контроллерам, которые возвращают сущности напрямую, всё равно нужен пример payload для @ApiResponse. Вставьте файл сущности и замените значения-заглушки в результате реалистичными.
Когда вы делаете запрос с relations: ["author"], фронтенду нужно знать, насколько глубоко вложен ответ. Вывод наглядно показывает, какие поля связей — объекты, а какие — массивы.
Используйте вывод как каркас тела запроса для POST-вызовов через supertest. Удалите генерируемые поля вроде id и меток времени, затем заполните остальное.
@Column вроде nullable, default или length не читаются; значение берётся из типа свойства или литерального инициализатора (status = "draft"). Если колонка может быть null, поменяйте значение на null сами.@Entity, не ссылающихся друг на друга, преобразуются все, с ключами по именам классов ({ "Book": {...}, "Author": {...} }). Сущности, ссылающиеся друг на друга, по-прежнему дают один вложенный корень.null.@Expose, группы сериализации и @Transform, используемые с ClassSerializerInterceptor, не применяются.@PrimaryGeneratedColumn("uuid") — пустая строка?Значение определяет только тип свойства. id: string даёт ""; аргумент "uuid" в декораторе не читается. Для документации потом подставьте значение в форме UUID.
Это совпадает с JSON.stringify полностью загруженной сущности. Связей, которые вы не загрузили через relations, в реальном ответе просто нет, так что считайте поля связей в выводе загруженным случаем.
Драйверы PostgreSQL и MySQL возвращают значения decimal строками, чтобы не терять точность. Объявите в сущности свойство как price: string — и вывод, как и ваши реальные данные, будет строкой.