Pega clases de entidad de TypeORM y obtén la forma JSON que producen esas entidades cuando las devuelves desde una API, rellenada con valores placeholder. Está pensado para proyectos NestJS o Express que devuelven las entidades directamente en las respuestas y necesitan ejemplos de Swagger o muestras de petición/respuesta para acordar con el frontend.
Los valores salen del tipo TypeScript de cada propiedad, no de las opciones de @Column. Por eso, una columna declarada como @Column({ type: "decimal" }) con price: number sale como el número 0.
TypeORM. Incluye las entidades relacionadas y los enums para que se puedan rellenar los objetos anidados.Resultado cambia en cuanto editas la entrada. Una entidad que ninguna otra referencia pasa a ser el objeto JSON de nivel superior; si hay varias entidades no relacionadas, cada una aparece bajo su nombre de clase.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 referencia a Author, así que Book es la raíz y author va anidado dentro. internalCode se descarta por @Exclude(), y price, de tipo number | null, sigue el primer tipo no nulo y pasa a 0. La clave primaria uuid está tipada como string, así que es una cadena vacía.
@ManyToOne y @OneToOne pasan a objetos anidados; Post[] de @OneToMany o @ManyToMany pasa a un array de un elemento.Promise<Post[]>) y el wrapper ESM Relation<User> se desenvuelven al tipo interior.@Exclude() de class-transformer, los campos static, los métodos y los getters.Date (de @CreateDateColumn y similares) pasan a cadenas ISO como 1970-01-01T00:00:00.000Z.Record<string, number>, se muestran como {"key": 0}.null o un array vacío para que el anidamiento sea finito.Los controllers que devuelven entidades directamente siguen necesitando un payload de ejemplo para @ApiResponse. Pega el archivo de la entidad y sustituye en el resultado los valores placeholder por otros realistas.
Cuando consultas con relations: ["author"], el frontend quiere saber a qué profundidad se anida la respuesta. La salida deja claro qué campos de relación son objetos y cuáles arrays.
Usa la salida como esqueleto del body de las peticiones POST con supertest. Borra los campos generados como id y los timestamps, y rellena el resto.
@Column como nullable, default o length; el valor sale del tipo de la propiedad o de un inicializador literal (status = "draft"). Si una columna puede ser null, cambia tú ese valor a null.@Entity que no se referencian entre sí se convierten todas, organizadas por nombre de clase ({ "Book": {...}, "Author": {...} }). Las entidades que sí se referencian siguen produciendo una sola raíz anidada.null.@Expose, los grupos de serialización ni @Transform usados con ClassSerializerInterceptor.@PrimaryGeneratedColumn("uuid") es una cadena vacía?Solo el tipo de la propiedad decide el valor. id: string da ""; el argumento "uuid" del decorador no se lee. Para la documentación, pon después un valor con forma de UUID.
Coincide con el JSON.stringify de una entidad cargada por completo. Las relaciones que no cargaste con relations simplemente no aparecen en la respuesta real, así que interpreta los campos de relación de la salida como el caso cargado.
Los drivers de PostgreSQL y MySQL devuelven los valores decimales como cadenas para evitar la pérdida de precisión. Declara la propiedad como price: string en la entidad y la salida, igual que tus datos reales, será una cadena.