I-convert ang mga Mongoose (TS) schema sa JSON!

Maglagay ng mga Mongoose (TS) schema para gumawa ng halimbawang JSON! Sinusuportahan ang Mongoose, NestJS @Prop. Magagamit sa API docs at test request body (mock request body).
Mongoose (TS)
Resulta
 

I-convert ang mga Mongoose (TS) schema sa JSON!

Bigyan ito ng mga @Schema() class na isinulat gamit ang @nestjs/mongoose ng NestJS, o mga simpleng TypeScript interface, at gagawa ito ng halimbawa ng document gaya ng pag-export dito ng toJSON(). Idinadagdag ang _id, __v at mga timestamp field ayon sa sariling rules ng Mongoose, kahit hindi sila dine-declare ng class.

Gamitin ito para tiyakin ang mga response DTO sa isang NestJS service, o para magkasundo kayo ng team mo sa itsura ng mga test document sa isang collection. Hindi tulad ng JS page, kinukuha ang mga value mula sa mga TypeScript property type sa halip na sa mga option ng @Prop().

Paano gamitin

  1. I-paste ang schema class file sa Mongoose (TS) box, kasama ang mga class na ginagamit bilang subdocument para mapunan ang mga array at nested object.
  2. Ang class na hindi nire-reference ng iba ang nagiging root; siguraduhing ang pangunahing document class mo ang nasa output.
  3. Palitan ang mga option gaya ng @Schema({ timestamps: true, versionKey: false }) at panoorin ang pag-update ng createdAt at __v sa resulta.

Halimbawa

Input (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);
Output (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"
}

Nire-reference ng Message ang Attachment, kaya Message ang root. Idinadagdag sa unahan ang _id, nagdadagdag ng dalawang date field ang timestamps: true, at tinatanggal ng versionKey: false ang __v. Nagiging sample ObjectId string ang roomId, na may type na Types.ObjectId.

Mga sinusuportahang feature

  • May _id ang root document (sample ObjectId na 507f1f77bcf86cd799439011) at, maliban kung versionKey: false, __v: 0; pinapalitan ng string na versionKey ang pangalan nito.
  • Idinadagdag ng @Schema({ timestamps: true }) ang createdAt at updatedAt bilang mga ISO string.
  • Nagiging ObjectId string ang Types.ObjectId at MongooseSchema.Types.ObjectId; nagiging 0 ang Types.Decimal128 at iba pang numeric type.
  • Nagiging array na may isang element, na pinunan mula sa class na iyon, ang mga array ng ibang class, gaya ng Attachment[].
  • Hindi pinapansin ang mga type alias gaya ng type UserDocument = HydratedDocument<User> kapag pumipili ng root, kaya ang totoong schema class ang nananaig.
  • Gumagana rin ang mga simpleng interface declaration na walang @Schema, kaya mai-paste nang ganoon lang ang isang model interface gaya ng IUser.

Mga gamit

Mga NestJS response at Swagger

Kapag direktang ibinabalik ng isang service ang this.model.find().lean(), ipinapakita nito ang eksaktong mga key na natatanggap ng mga client, kasama ang _id at __v na tumatagas sa response.

Mga test document para sa mongosh

Baguhin nang kaunti ang output at ipasa ito sa db.messages.insertOne() para mabilis na mag-seed ng local database. Ibalot sa ObjectId("...") ang mga ObjectId string kapag ginawa mo iyon.

Mga paalala at limitasyon

  • Itinuturing na subdocument ang mga nested class na may decorator na @Schema(): may sarili silang _id (maliban kung @Schema({ _id: false })) at timestamps, pero hindi kailanman __v. Nananatiling simpleng object ang mga nested class na walang @Schema.
  • Ginagamit bilang sample value ang literal na @Prop({ default: ... }); hindi binabasa ang mga option na required at enum. Para sa fixed na set ng value, mag-declare ng TypeScript literal union at ang unang value nito ang gagamitin.
  • Lumalabas bilang {"key": null} ang Record<string, any> na dine-declare gamit ang @Prop({ type: Object }).
  • Hindi ina-apply ang mga virtual, toJSON transform at select: false.

Mga madalas itanong

Pinapalitan ng API ko ng id ang _id, pero _id ang ipinapakita ng output.

Sinusunod ng output ang default na toJSON() ng Mongoose. Kung nagdadagdag ang schema mo ng id sa pamamagitan ng toJSON: { virtuals: true } o isang transform, palitan ang pangalan ng key sa resulta.

Paano kung nasa mga option lang ang type, gaya ng @Prop({ type: [String] })?

Galing sa naka-declare na type ng property ang mga value. Sa tags: string[], [""] ang makukuha mo; kapag walang TypeScript type talaga, hindi alam ang value at nagiging null.

Puwede ko bang i-convert dito ang isang JavaScript na new Schema({...})?

Gamitin ang page na Mongoose (JS) to JSON para sa mga JavaScript schema object. Direkta nitong binabasa ang mga schema option gaya ng { type: String, enum: [...] }.