粘贴 TypeORM 实体类,就能得到这些实体从 API 返回时生成的 JSON 结构,并填好占位值。它面向直接在响应中返回实体的 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() 而被去掉;类型为 number | null 的 price 取第一个非 null 类型,变成 0。uuid 主键的类型是 string,所以是空字符串。
@ManyToOne 和 @OneToOne 关系变成嵌套对象;@OneToMany 或 @ManyToMany 的 Post[] 变成单元素数组。Promise<Post[]>)和 ESM 的 Relation<User> 包装会被拆开,取内部类型。@Exclude() 的字段、static 字段、方法和 getter 都会被排除。Date 属性(来自 @CreateDateColumn 等)变成 1970-01-01T00:00:00.000Z 这样的 ISO 字符串。Record<string, number>,显示为 {"key": 0}。null 或空数组截断,保证嵌套有限。直接返回实体的 controller 仍然需要为 @ApiResponse 提供示例 payload。粘贴实体文件,再把结果中的占位值换成真实的值即可。
用 relations: ["author"] 查询时,前端想知道响应嵌套有多深。输出清楚地显示了哪些关系字段是对象,哪些是数组。
把输出用作 supertest POST 请求体的骨架。删掉 id 和时间戳等生成的字段,再填好其余部分。
nullable、default、length 等 @Column 选项;值来自属性类型或字面量初始值(status = "draft")。如果某列可能为 null,请自行把值改成 null。@Entity 类都会被转换,并以类名为 key({ "Book": {...}, "Author": {...} })。互相引用的实体仍然只生成一个嵌套的根。null。ClassSerializerInterceptor 一起使用的 @Expose、序列化分组和 @Transform。@PrimaryGeneratedColumn("uuid") 是空字符串?值只由属性类型决定。id: string 得到 "";装饰器中的 "uuid" 参数不会被读取。用于文档时,之后再换成 UUID 形式的值即可。
它与完整加载的实体经 JSON.stringify 的结果一致。没有通过 relations 加载的关系,在真实响应中根本不会出现,所以请把输出中的关系字段视为已加载的情况。
PostgreSQL 和 MySQL 驱动为避免精度丢失,会以字符串返回 decimal 值。在实体中把属性声明为 price: string,输出就会和真实数据一样变成字符串。