Mongoose(TS)のスキーマをJSONに変換!

Mongoose(TS)のスキーマを入力するとサンプルJSONを作ります!Mongoose, NestJS @Prop 対応。API ドキュメントやテスト用のリクエストボディ(sample JSON)に。
Mongoose (TS)
結果
 

Mongoose(TS)のスキーマをJSONに変換!

NestJS の @nestjs/mongoose で書いた @Schema() クラスや、素の TypeScript インターフェースを渡すと、toJSON() が書き出すドキュメントの例を作ります。_id、__v、タイムスタンプのフィールドは、クラスで宣言していなくても Mongoose 自身のルールに従って追加されます。

NestJS のサービスでレスポンス DTO を確定させたいときや、コレクションのテスト用ドキュメントの形をチームですり合わせたいときに使ってください。JS 版のページと違い、値は @Prop() のオプションではなく TypeScript のプロパティ型から取ります。

使い方

  1. Mongoose (TS) 欄にスキーマクラスのファイルを貼り付けます。配列やネストしたオブジェクトが埋まるよう、サブドキュメントとして使うクラスも含めてください。
  2. どこからも参照されていないクラスがルートになります。メインのドキュメントクラスが出力されているか確認してください。
  3. @Schema({ timestamps: true, versionKey: false }) のようなオプションを変えると、結果の createdAt や __v が更新されるのを確認できます。

例

入力 (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);
出力 (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 が Attachment を参照しているので、Message がルートです。_id が先頭に追加され、timestamps: true で日付のフィールドが2つ加わり、versionKey: false で __v が消えています。Types.ObjectId 型の roomId はサンプルの ObjectId 文字列になります。

対応機能

  • ルートのドキュメントには _id(サンプルの ObjectId 507f1f77bcf86cd799439011)と、versionKey: false でない限り __v: 0 が付きます。versionKey が文字列なら名前が変わります。
  • @Schema({ timestamps: true }) は createdAt と updatedAt を ISO 文字列で追加します。
  • Types.ObjectId と MongooseSchema.Types.ObjectId は ObjectId 文字列に、Types.Decimal128 やその他の数値型は 0 になります。
  • Attachment[] のような別クラスの配列は、そのクラスから埋めた要素1つの配列になります。
  • type UserDocument = HydratedDocument<User> のような型エイリアスはルートを選ぶときに無視されるので、本来のスキーマクラスが選ばれます。
  • @Schema のない素の interface 宣言にも対応しているので、IUser のようなモデルのインターフェースもそのまま貼り付けられます。

利用シーン

NestJS のレスポンスと Swagger

サービスが this.model.find().lean() をそのまま返す場合、レスポンスに漏れ出す _id や __v も含めて、クライアントが受け取るキーを正確に示せます。

mongosh 用のテストドキュメント

出力を少し手直しして db.messages.insertOne() に渡せば、ローカルのデータベースに手早くデータを入れられます。その際、ObjectId の文字列は ObjectId("...") で包んでください。

注意点と制限

  • @Schema() を付けたネストしたクラスはサブドキュメントとして扱われ、(@Schema({ _id: false }) でない限り)独自の _id とタイムスタンプを持ちますが、__v は付きません。@Schema のないネストしたクラスは普通のオブジェクトのままです。
  • リテラルの @Prop({ default: ... }) はサンプル値として使いますが、required や enum のオプションは読みません。値の種類が決まっている場合は TypeScript のリテラルのユニオンで宣言すれば、その最初の値が使われます。
  • @Prop({ type: Object }) で宣言した Record<string, any> は {"key": null} として表示されます。
  • virtual、toJSON の transform、select: false は反映されません。

よくある質問

API では _id を id に変えているのに、出力には _id が出ます。

出力は Mongoose の既定の toJSON() に従っています。スキーマで toJSON: { virtuals: true } や transform によって id を追加しているなら、結果のキーを書き換えてください。

@Prop({ type: [String] }) のように、型がオプションにしかない場合は?

値はプロパティの宣言された型から作ります。tags: string[] なら [""] になり、TypeScript の型がまったくなければ値がわからないので null になります。

JavaScript の new Schema({...}) をここで変換できますか?

JavaScript のスキーマオブジェクトには Mongoose (JS) → JSON のページを使ってください。そちらは { type: String, enum: [...] } のようなスキーマのオプションを直接読み取ります。