Mongoose-Schemas (TS) in JSON umwandeln!

Gib Mongoose-Schemas (TS) ein, um Beispiel-JSON zu erzeugen! Unterstützt Mongoose, NestJS @Prop. Praktisch für API-Dokumentation und Test-Request-Bodys (mock request body).
Mongoose (TS)
Ergebnis
 

Mongoose-Schemas (TS) in JSON umwandeln!

Gib @Schema()-Klassen ein, die mit @nestjs/mongoose von NestJS geschrieben sind, oder einfache TypeScript-Interfaces, und du bekommst ein Beispiel des Dokuments, wie toJSON() es exportieren würde. _id, __v und die Timestamp-Felder werden nach den Regeln von Mongoose ergänzt, auch wenn die Klasse sie nicht deklariert.

Verwende es, um Response-DTOs in einem NestJS-Service festzuzurren oder um dich mit deinem Team darauf zu einigen, wie Testdokumente in einer Collection aussehen sollen. Anders als auf der JS-Seite werden die Werte aus den TypeScript-Property-Typen genommen, nicht aus den @Prop()-Optionen.

So funktioniert es

  1. Füge die Datei mit der Schemaklasse in das Feld Mongoose (TS) ein, einschließlich der Klassen, die als Subdokumente dienen, damit Arrays und verschachtelte Objekte befüllt werden.
  2. Die Klasse, auf die niemand sonst verweist, wird zur Wurzel; achte darauf, dass deine Hauptdokumentklasse diejenige in der Ausgabe ist.
  3. Ändere Optionen wie @Schema({ timestamps: true, versionKey: false }) und sieh zu, wie sich createdAt und __v im Ergebnis aktualisieren.

Beispiel

Eingabe (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);
Ausgabe (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 verweist auf Attachment, daher ist Message die Wurzel. _id wird vorangestellt, timestamps: true fügt zwei Datumsfelder hinzu, und versionKey: false entfernt __v. roomId mit dem Typ Types.ObjectId wird zu einem Beispiel-ObjectId-String.

Unterstützte Funktionen

  • Das Wurzeldokument bekommt _id (Beispiel-ObjectId 507f1f77bcf86cd799439011) und, sofern nicht versionKey: false, __v: 0; ein String als versionKey benennt es um.
  • @Schema({ timestamps: true }) hängt createdAt und updatedAt als ISO-Strings an.
  • Types.ObjectId und MongooseSchema.Types.ObjectId werden zu ObjectId-Strings; Types.Decimal128 und andere numerische Typen werden zu 0.
  • Arrays einer anderen Klasse wie Attachment[] werden zu einem Array mit einem Element, das aus dieser Klasse befüllt wird.
  • Typ-Aliase wie type UserDocument = HydratedDocument<User> werden bei der Wahl der Wurzel ignoriert, sodass die echte Schemaklasse gewinnt.
  • Auch einfache interface-Deklarationen ohne @Schema funktionieren, ein Modell-Interface wie IUser lässt sich also unverändert einfügen.

Anwendungsfälle

NestJS-Antworten und Swagger

Gibt ein Service this.model.find().lean() direkt zurück, zeigt dir das die exakten Keys, die Clients erhalten, einschließlich _id und __v, die in die Antwort durchsickern.

Testdokumente für mongosh

Passe die Ausgabe an und übergib sie an db.messages.insertOne(), um eine lokale Datenbank schnell zu befüllen. Setze ObjectId-Strings dabei in ObjectId("...").

Hinweise und Einschränkungen

  • Mit @Schema() dekorierte verschachtelte Klassen werden als Subdokumente behandelt: Sie bekommen ein eigenes _id (außer bei @Schema({ _id: false })) und Timestamps, aber nie __v. Verschachtelte Klassen ohne @Schema bleiben einfache Objekte.
  • Ein literales @Prop({ default: ... }) dient als Beispielwert; die Optionen required und enum werden nicht gelesen. Für eine feste Wertemenge deklarierst du eine TypeScript-Literal-Union, dann wird ihr erster Wert verwendet.
  • Ein mit @Prop({ type: Object }) deklariertes Record<string, any> erscheint als {"key": null}.
  • Virtuals, toJSON-Transforms und select: false werden nicht angewendet.

Häufige Fragen

Meine API benennt _id in id um, die Ausgabe zeigt aber _id.

Die Ausgabe folgt dem Standard-toJSON() von Mongoose. Fügt dein Schema id über toJSON: { virtuals: true } oder einen Transform hinzu, benenne den Key im Ergebnis um.

Was, wenn der Typ nur in den Optionen steht, wie bei @Prop({ type: [String] })?

Die Werte stammen aus dem deklarierten Typ der Property. Mit tags: string[] bekommst du [""]; ganz ohne TypeScript-Typ ist der Wert unbekannt und wird zu null.

Kann ich hier ein JavaScript-new Schema({...}) umwandeln?

Für JavaScript-Schemaobjekte nimm die Seite Mongoose (JS) zu JSON. Sie liest Schema-Optionen wie { type: String, enum: [...] } direkt.