Konvertieren Sie JSON in ein Mongoose-Schema (TypeScript)!

Geben Sie JSON ein und konvertieren Sie es in ein Mongoose-Schema (TypeScript)! Unterstützt NestJS @nestjs/mongoose @Schema, @Prop, SchemaFactory, MongoDB.
JSON
Ergebnis
 

Konvertieren Sie JSON in ein Mongoose-Schema (TypeScript)!

Macht aus JSON eine Schemaklasse für NestJS mit @nestjs/mongoose: eine @Schema()-Klasse mit @Prop() an jedem Feld, das mit SchemaFactory.createForClass() gebaute Schema und einen Typ ProductDocument, alles in einer Datei. Jedes Feld trägt außerdem @IsNotEmpty() oder @IsOptional() von class-validator.

Verwende es, wenn ein NestJS-Modul ein Schema zum Registrieren mit MongooseModule.forFeature() braucht, du bereits ein Beispiel des zu speichernden Dokuments hast und das Schreiben jedes Decorators von Hand der langsame Teil ist.

So funktioniert es

  1. Füge ein Beispieldokument in die Eingabe ein. Sind manche Felder nur gelegentlich vorhanden, füge mehrere Dokumente als Array ein, damit optionale Felder erkannt werden.
  2. Gib den Klassennamen in Modellname ein (Standard MyModel). Aus der Eingabe product entstehen Product, ProductDocument und ProductSchema.
  3. Speichere das Ergebnis als product.schema.ts und registriere es mit MongooseModule.forFeature([{ name: Product.name, schema: ProductSchema }]).

Beispiel

Eingabe (JSON)
{
  "sku": "KB-87-RED",
  "title": "Mechanical keyboard",
  "price": 89.5,
  "stock": 42,
  "discontinued": false,
  "restocked_at": "2024-03-18"
}
Ausgabe (NestJS @nestjs/mongoose)
import { Prop, Schema, SchemaFactory } from '@nestjs/mongoose';
import { Document, Schema as MongooseSchema } from 'mongoose';
import { IsNotEmpty, IsOptional } from 'class-validator';

export type ProductDocument = Product & Document;

@Schema()
export class Product {
  _id: MongooseSchema.Types.ObjectId;

  @Prop({ type: MongooseSchema.Types.String, required: true })
  @IsNotEmpty()
  sku: string;

  @Prop({ type: MongooseSchema.Types.String, required: true })
  @IsNotEmpty()
  title: string;

  @Prop({ type: MongooseSchema.Types.Number, required: true })
  @IsNotEmpty()
  price: number;

  @Prop({ type: MongooseSchema.Types.Number, required: true })
  @IsNotEmpty()
  stock: number;

  @Prop({ type: MongooseSchema.Types.Boolean, required: true })
  @IsNotEmpty()
  discontinued: boolean;

  @Prop({ type: MongooseSchema.Types.Date, required: true })
  @IsNotEmpty()
  restocked_at: Date;
}

export const ProductSchema = SchemaFactory.createForClass(Product);

Das Beispiel ist ein einzelnes, vollständig befülltes Dokument, daher bekommt jedes Feld required: true und @IsNotEmpty(). restocked_at ist ein String im Datumsformat und wird deshalb als Date typisiert, und die Property behält den gespeicherten Key-Namen restocked_at.

Unterstützte Funktionen

  • Mongoose-Typen werden explizit angegeben, z. B. @Prop({ type: MongooseSchema.Types.String, required: true }). Schema von Mongoose wird als MongooseSchema importiert, damit es nicht mit dem Decorator Schema kollidiert.
  • TypeScript-Typen: number, boolean, Date für ISO-8601-Datums-Strings, string für alles andere, auch für reine Ziffern-Strings wie "0042".
  • Verschachtelte Objekte werden mit MongooseSchema.Types.Mixed deklariert und als Record<string, unknown> typisiert; Arrays eines einfachen Typs werden z. B. zu [MongooseSchema.Types.String] mit string[].
  • Property-Namen sind die unveränderten JSON-Keys, bei Bedarf in Anführungszeichen ('home-url': string), damit die Klasse zu Dokumenten passt, die bereits in der Collection liegen.
  • Felder mit nicht leerem Wert in jedem Dokument bekommen required: true plus @IsNotEmpty(); die übrigen nur @IsOptional(). Ein Key _id in der Eingabe wird übersprungen, weil _id: MongooseSchema.Types.ObjectId bereits deklariert ist.
  • export type ProductDocument = Product & Document wird für Injection wie @InjectModel(Product.name) model: Model<ProductDocument> erzeugt.

Anwendungsfälle

Einem NestJS-Service eine Collection hinzufügen

Gib ein Event-Payload ein, das dir ein anderes Team geschickt hat, oder das JSON eines Scrapers, um die Schemaklasse zu bekommen; injiziere sie dann mit @InjectModel und rufe sofort create oder find auf.

Ein Express-Mongoose-Modell nach NestJS umziehen

Exportiere ein paar Dokumente, die das alte new Schema({...})-Modell gespeichert hat, und füge sie hier ein, um es als decorator-basierte Klasse neu zu schreiben, ohne beim Abschreiben von Hand Felder zu verlieren.

Hinweise und Einschränkungen

  • @IsNotEmpty() und @IsOptional() sitzen an der Schemaklasse, ValidationPipe validiert aber Controller-DTOs. Um Requests zu validieren, verschiebe diese Decorators in eine DTO-Klasse oder lege eine an.
  • @Schema() hat keine Optionen, der Collection-Name folgt also der Mongoose-Regel, den Modellnamen kleinzuschreiben und in den Plural zu setzen: products. Setze @Schema({ collection: 'product' }), wenn du einen bestimmten Namen brauchst.
  • Optionale Felder kommen trotzdem ohne ? heraus (z. B. memo: string). Mit strictNullChecks ist es sicherer, sie in memo?: string zu ändern.
  • Sub-Dokumente werden als Mixed statt als typisierte Schemas gespeichert. Für Validierung darin definierst du eine eigene @Schema()-Klasse und verwendest @Prop({ type: SubSchema }).

Häufige Fragen

Warum & Document, statt von Document zu erben?

Das folgt dem Standardmuster der NestJS-Doku: Die Schemaklasse bleibt eine reine Felddefinition, und ProductDocument wird nur dort verwendet, wo Methoden von Mongoose-Dokumenten wie save() gebraucht werden. Ab Mongoose 7 ist HydratedDocument<Product> ein direkter Ersatz.

Was, wenn mein Projekt class-validator nicht verwendet?

Lösche die Zeile import { IsNotEmpty, IsOptional } from 'class-validator' und die beiden Decorators an jedem Feld. Das Verhalten des Schemas wird allein durch required in @Prop() gesteuert.

Muss ich type in @Prop() angeben?

Mit emitDecoratorMetadata lassen sich einfache Typen ableiten, bei Arrays und Unions wie Date | null scheitert die Ableitung aber. Der erzeugte Code gibt type von vornherein an, damit das Verhalten gleich bleibt, wenn du später den TypeScript-Typ einer Property änderst.