Convertissez des schémas Mongoose (JS) en JSON !

Saisissez des schémas Mongoose (JS) pour générer un JSON d'exemple ! Compatible avec Mongoose new Schema, mongoose.model. Pratique pour documenter une API et créer des corps de requête de test (mock request body).
Mongoose (JS)
Résultat
 

Convertissez des schémas Mongoose (JS) en JSON !

Construisez un document JSON d'exemple à partir d'un schéma Mongoose JavaScript défini avec new Schema({...}). Comme l'objet de définition du schéma lui-même est analysé, les options comme { type: String, enum: [...] } ou { type: Map, of: Number } et les références à d'autres variables de schéma sont suivies.

Utile pour documenter les collections derrière une API Express + Mongoose, ou pour expliquer au frontend à quoi ressemble un document. Les règles propres à Mongoose sont respectées, par exemple les sous-documents de tableau qui reçoivent un _id contrairement aux chemins imbriqués.

Mode d'emploi

  1. Collez le fichier de schéma dans le champ Mongoose (JS). Si des sous-schémas sont dans des variables séparées, incluez leurs définitions dans la même entrée.
  2. Un schéma utilisé par aucun autre devient le document racine ; s'il y en a plusieurs, la sortie est indexée par nom de variable.
  3. Relisez le résultat et copiez-le avec le bouton de copie.

Exemple

Entrée (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 } }
);
Sortie (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] est un tableau de sous-documents : chaque élément reçoit donc _id, alors que __v n'existe qu'au niveau racine. dimensions n'a pas de type : c'est un chemin imbriqué sans _id, et Decimal128 apparaît sous sa forme toJSON(), $numberDecimal. L'option timestamps renomme le champ en created_at et désactive updatedAt, ce qui ne laisse qu'un seul champ de date.

Fonctionnalités prises en charge

  • Le document racine reçoit _id et __v, en respectant un renommage versionKey: "rev" ou false.
  • Les sous-documents de tableau comme [subSchema] ou [{ name: String }] reçoivent _id, sauf si le schéma définit { _id: false }.
  • Les objets imbriqués sans type (address: { city: String }) restent des objets simples sans _id.
  • Les tableaux enum donnent leur première valeur, { type: Map, of: String } donne {"key": ""}, et Schema.Types.Mixed donne null.
  • Schema.Types.ObjectId devient une chaîne ObjectId d'exemple et Decimal128 devient {"$numberDecimal": "0"}.
  • Au-delà de timestamps: true, les réglages détaillés comme { createdAt: "created_at", updatedAt: false } sont lus.
  • Les références circulaires entre schémas sont coupées avec null.

Cas d'utilisation

Une doc de collections qui reste exacte

Quand un README ou un wiki montre un document d'exemple par collection, le générer à partir du fichier de schéma empêche la doc de s'éloigner du code.

Repérer les `_id` des sous-documents

Le frontend compare souvent des éléments de tableau sans savoir que chacun porte son propre _id. La sortie montre clairement à quel niveau _id apparaît.

Expliquer les réponses avant populate

Les champs avec ref sont de simples chaînes ObjectId tant qu'ils ne sont pas peuplés. Servez-vous de la sortie comme référence pour décrire comment une réponse change après populate().

Remarques et limites

  • Un default littéral ("active", 0, true) sert de valeur d'exemple. Les valeurs par défaut fonctions comme Date.now ne sont pas exécutées : ces champs reçoivent la valeur générique du type.
  • Les champs avec ref restent des chaînes ObjectId plutôt que des objets peuplés.
  • Un new Schema({...}, { _id: false }) inline écrit comme valeur de champ est converti sur place en respectant ses propres options ; il n'apparaît pas comme une entrée racine séparée.
  • Les virtuals, les transformations toJSON, les getters et select: false ne sont pas appliqués.

FAQ

Pourquoi un champ Decimal128 sort-il sous forme d'objet ?

Le Decimal128 de Mongoose est sérialisé via toJSON() en {"$numberDecimal": "12.50"}. Si vous l'envoyez comme nombre ou chaîne, ajoutez un getter ou une transformation au schéma et modifiez la sortie en conséquence.

Puis-je coller ici des schémas TypeScript ou NestJS ?

Convertissez les classes @Schema() et les interfaces sur la page Mongoose (TS) vers JSON. Cette page analyse l'objet JavaScript passé à new Schema().

Et si le fichier ne contient que mongoose.model() et que le schéma est ailleurs ?

La définition du schéma doit figurer dans l'entrée. Collez aussi la partie new Schema(...).