¡Convierte esquemas de Mongoose (TS) en JSON!

¡Introduce esquemas de Mongoose (TS) para generar JSON de ejemplo! Compatible con Mongoose, NestJS @Prop. Útil para documentar APIs y cuerpos de petición de prueba (mock request body).
Mongoose (TS)
Resultado
 

¡Convierte esquemas de Mongoose (TS) en JSON!

Pásale clases @Schema() escritas con @nestjs/mongoose de NestJS, o interfaces simples de TypeScript, y produce un ejemplo del documento tal como lo exportaría toJSON(). _id, __v y los campos de timestamps se añaden siguiendo las reglas de Mongoose, aunque la clase no los declare.

Úsalo para fijar los DTOs de respuesta en un servicio NestJS, o para acordar con tu equipo cómo deben ser los documentos de prueba de una colección. A diferencia de la página de JS, los valores se toman de los tipos TypeScript de las propiedades y no de las opciones de @Prop().

Cómo usar

  1. Pega el archivo de clases de schema en el cuadro Mongoose (TS), incluidas las clases usadas como subdocumentos para que se rellenen los arrays y objetos anidados.
  2. La clase que nadie más referencia pasa a ser la raíz; asegúrate de que tu clase de documento principal es la que aparece en la salida.
  3. Cambia opciones como @Schema({ timestamps: true, versionKey: false }) y observa cómo se actualizan createdAt y __v en el resultado.

Ejemplo

Entrada (NestJS · @nestjs/mongoose)
@Schema({ _id: false })
export class Attachment {
  @Prop() url: string;
  @Prop() size: number;
}

@Schema({ timestamps: true, versionKey: false })
export class Message {
  @Prop({ type: Types.ObjectId, ref: "Room", required: true })
  roomId: Types.ObjectId;

  @Prop({ required: true })
  text: string;

  @Prop({ type: [Attachment], default: [] })
  attachments: Attachment[];

  @Prop()
  readAt?: Date;
}

export const MessageSchema = SchemaFactory.createForClass(Message);
Salida (JSON)
{
  "_id": "507f1f77bcf86cd799439011",
  "roomId": "507f1f77bcf86cd799439011",
  "text": "",
  "attachments": [
    {
      "url": "",
      "size": 0
    }
  ],
  "readAt": "1970-01-01T00:00:00.000Z",
  "createdAt": "1970-01-01T00:00:00.000Z",
  "updatedAt": "1970-01-01T00:00:00.000Z"
}

Message referencia a Attachment, así que Message es la raíz. Se antepone _id, timestamps: true añade dos campos de fecha y versionKey: false elimina __v. roomId, de tipo Types.ObjectId, pasa a una cadena ObjectId de ejemplo.

Funciones compatibles

  • El documento raíz recibe _id (ObjectId de ejemplo 507f1f77bcf86cd799439011) y, salvo con versionKey: false, __v: 0; un versionKey de tipo cadena lo renombra.
  • @Schema({ timestamps: true }) añade createdAt y updatedAt como cadenas ISO.
  • Types.ObjectId y MongooseSchema.Types.ObjectId pasan a cadenas ObjectId; Types.Decimal128 y los demás tipos numéricos pasan a 0.
  • Los arrays de otra clase, como Attachment[], pasan a un array de un elemento rellenado a partir de esa clase.
  • Los alias de tipo como type UserDocument = HydratedDocument<User> se ignoran al elegir la raíz, así que gana la clase de schema real.
  • También funcionan las declaraciones interface simples sin @Schema, así que una interfaz de modelo como IUser se puede pegar tal cual.

Casos de uso

Respuestas de NestJS y Swagger

Cuando un servicio devuelve directamente this.model.find().lean(), esto muestra exactamente las claves que reciben los clientes, incluidos los _id y __v que se cuelan en la respuesta.

Documentos de prueba para mongosh

Retoca la salida y pásala a db.messages.insertOne() para poblar rápido una base de datos local. Al hacerlo, envuelve las cadenas ObjectId en ObjectId("...").

Notas y limitaciones

  • Las clases anidadas decoradas con @Schema() se tratan como subdocumentos: reciben su propio _id (salvo con @Schema({ _id: false })) y timestamps, pero nunca __v. Las clases anidadas sin @Schema se quedan como objetos simples.
  • Un @Prop({ default: ... }) literal se usa como valor de ejemplo; las opciones required y enum no se leen. Para un conjunto fijo de valores, declara una unión de literales de TypeScript y se usará su primer valor.
  • Un Record<string, any> declarado con @Prop({ type: Object }) aparece como {"key": null}.
  • No se aplican los virtuals, las transformaciones toJSON ni select: false.

Preguntas frecuentes

Mi API renombra _id a id, pero la salida muestra _id.

La salida sigue el toJSON() por defecto de Mongoose. Si tu schema añade id mediante toJSON: { virtuals: true } o una transformación, renombra la clave en el resultado.

¿Y si el tipo solo está en las opciones, como @Prop({ type: [String] })?

Los valores salen del tipo declarado de la propiedad. Con tags: string[] obtienes [""]; sin ningún tipo TypeScript, el valor es desconocido y pasa a null.

¿Puedo convertir aquí un new Schema({...}) de JavaScript?

Usa la página Mongoose (JS) a JSON para objetos de schema en JavaScript. Esa página lee directamente opciones del schema como { type: String, enum: [...] }.