Mongoose-Schemas (JS) in JSON umwandeln!

Gib Mongoose-Schemas (JS) ein, um Beispiel-JSON zu erzeugen! Unterstützt Mongoose new Schema, mongoose.model. Praktisch für API-Dokumentation und Test-Request-Bodys (mock request body).
Mongoose (JS)
Ergebnis
 

Mongoose-Schemas (JS) in JSON umwandeln!

Erzeuge Beispiel-JSON eines Dokuments aus einem JavaScript-Mongoose-Schema, das mit new Schema({...}) definiert ist. Da das Definitionsobjekt des Schemas selbst geparst wird, werden Optionen wie { type: String, enum: [...] } oder { type: Map, of: Number } sowie Verweise auf andere Schema-Variablen verfolgt.

Das hilft beim Dokumentieren der Collections hinter einer Express-+-Mongoose-API oder wenn du dem Frontend erklärst, wie ein Dokument aussieht. Mongoose-spezifische Regeln werden übernommen, etwa dass Subdokumente in Arrays ein _id bekommen, verschachtelte Pfade aber nicht.

So funktioniert es

  1. Füge die Schemadatei in das Feld Mongoose (JS) ein. Liegen Sub-Schemas in eigenen Variablen, nimm ihre Definitionen in dieselbe Eingabe auf.
  2. Ein Schema, das von keinem anderen Schema verwendet wird, wird zum Wurzeldokument; gibt es mehrere, ist die Ausgabe nach Variablennamen geschlüsselt.
  3. Prüfe das Ergebnis und kopiere es mit dem Kopier-Button.

Beispiel

Eingabe (Mongoose · JavaScript)
const variantSchema = new Schema({
  sku: String,
  price: Schema.Types.Decimal128,
  stock: { type: Number, default: 0 },
});

const productSchema = new Schema(
  {
    title: { type: String, required: true },
    variants: [variantSchema],
    dimensions: { width: Number, height: Number },
    labels: { type: Map, of: String },
  },
  { timestamps: { createdAt: "created_at", updatedAt: false } }
);
Ausgabe (JSON)
{
  "_id": "507f1f77bcf86cd799439011",
  "title": "",
  "variants": [
    {
      "_id": "507f1f77bcf86cd799439011",
      "sku": "",
      "price": {
        "$numberDecimal": "0"
      },
      "stock": 0
    }
  ],
  "dimensions": {
    "width": 0,
    "height": 0
  },
  "labels": {
    "key": ""
  },
  "created_at": "1970-01-01T00:00:00.000Z",
  "__v": 0
}

variants: [variantSchema] ist ein Array von Subdokumenten, daher bekommt jedes Element ein _id, während __v nur auf oberster Ebene existiert. dimensions hat kein type und ist daher ein verschachtelter Pfad ohne _id, und Decimal128 erscheint in seiner toJSON()-Form, $numberDecimal. Die Timestamps-Option benennt das Feld in created_at um und deaktiviert updatedAt, sodass ein einziges Datumsfeld übrig bleibt.

Unterstützte Funktionen

  • Das Wurzeldokument bekommt _id und __v und beachtet Umbenennungen per versionKey: "rev" oder false.
  • Subdokumente in Arrays wie [subSchema] oder [{ name: String }] bekommen ein _id, es sei denn, das Schema setzt { _id: false }.
  • Verschachtelte Objekte ohne type (address: { city: String }) bleiben einfache Objekte ohne _id.
  • enum-Arrays liefern ihren ersten Wert, { type: Map, of: String } ergibt {"key": ""}, und Schema.Types.Mixed ergibt null.
  • Schema.Types.ObjectId wird zu einem Beispiel-ObjectId-String und Decimal128 zu {"$numberDecimal": "0"}.
  • Über timestamps: true hinaus werden auch detaillierte Einstellungen wie { createdAt: "created_at", updatedAt: false } gelesen.
  • Zirkuläre Verweise zwischen Schemas werden mit null abgeschnitten.

Anwendungsfälle

Collection-Dokus, die korrekt bleiben

Zeigt eine README oder ein Wiki ein Beispieldokument pro Collection, verhindert das Erzeugen aus der Schemadatei, dass sich die Doku vom Code entfernt.

`_id`s in Subdokumenten erkennen

Frontends vergleichen Array-Elemente oft, ohne zu bemerken, dass jedes ein eigenes _id trägt. Die Ausgabe macht deutlich, auf welcher Ebene _id auftaucht.

Antworten vor populate erklären

Felder mit ref sind bis zum Populate einfache ObjectId-Strings. Nimm die Ausgabe als Ausgangspunkt, wenn du beschreibst, wie sich eine Antwort nach populate() verändert.

Hinweise und Einschränkungen

  • Ein literales default ("active", 0, true) dient als Beispielwert. Funktions-Standardwerte wie Date.now werden nicht ausgeführt, diese Felder bekommen stattdessen den Platzhalter des Typs.
  • Felder mit ref bleiben ObjectId-Strings statt aufgelöster Objekte.
  • Ein inline als Feldwert geschriebenes new Schema({...}, { _id: false }) wird an Ort und Stelle umgewandelt und beachtet seine eigenen Optionen; es erscheint nicht als eigener Wurzeleintrag.
  • Virtuals, toJSON-Transforms, Getter und select: false werden nicht angewendet.

Häufige Fragen

Warum kommt ein Decimal128-Feld als Objekt heraus?

Decimal128 von Mongoose serialisiert über toJSON() als {"$numberDecimal": "12.50"}. Sendest du es als Zahl oder String, ergänze am Schema einen Getter oder Transform und passe die Ausgabe entsprechend an.

Kann ich hier TypeScript- oder NestJS-Schemas einfügen?

@Schema()-Klassen und Interfaces wandelst du auf der Seite Mongoose (TS) zu JSON um. Diese Seite parst das JavaScript-Objekt, das an new Schema() übergeben wird.

Was, wenn in der Datei nur mongoose.model() steht und das Schema woanders liegt?

Die Schemadefinition muss in der Eingabe stehen. Füge den Teil new Schema(...) mit ein.