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

JSONを入力してMongoose(JavaScript)スキーマに変換します!Mongoose new Schema, mongoose.model, MongoDB, Node.js 対応。
JSON
結果
 

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

MongoDB に保存する予定のドキュメントを貼り付けると、CommonJS の Mongoose スキーマファイルが得られます。new Schema({...}) でフィールドを定義し、mongoose.model() でモデルを登録し、最後に module.exports を置いた形です。Express プロジェクトの models/ フォルダーに保存すれば、そのまま require できます。

フィールドのパスは JSON のキーをそのまま使うので、コレクションにすでにあるドキュメントも名前を変えずに読み取れます。ドキュメントの配列を貼り付けると、すべてのドキュメントのキーが1つのスキーマにまとめられます。

使い方

  1. ドキュメントを1つ(オブジェクト)または複数(配列)貼り付けます。mongoexport の出力を配列で囲んだものでも使えます。
  2. モデル名 を入力します(既定は MyModel)。スペースを含めても構わず、blog comment は BlogComment になります。
  3. 結果を models/Comment.js のようなファイルに保存し、ルーターで const Comment = require('./models/Comment') として読み込みます。

例

入力 (JSON)
[
  { "author": "mina", "body": "Great post!", "likes": 3, "approved": true, "posted_at": "2024-05-01T09:30:00Z" },
  { "author": "leo", "body": "Typo in step 2", "likes": 0, "approved": false, "posted_at": "2024-05-02T11:00:00Z", "reply_to": "6634a1" }
]
出力 (Mongoose (JavaScript))
const mongoose = require('mongoose');
const { Schema } = mongoose;

const commentSchema = new Schema({
  _id: { type: Schema.Types.ObjectId, auto: true },
  author: { type: Schema.Types.String, required: true },
  body: { type: Schema.Types.String, required: true },
  likes: { type: Schema.Types.Number, required: true },
  approved: { type: Schema.Types.Boolean, required: true },
  posted_at: { type: Schema.Types.Date, required: true },
  reply_to: { type: Schema.Types.String }
});

const Comment = mongoose.model('Comment', commentSchema);

module.exports = Comment;

reply_to は2つ目のコメントにしかないので required なしで生成され、ISO 形式の日付文字列である posted_at は Schema.Types.Date になります。スキーマのパスは保存されているキーと一致する必要があるため、どちらも snake_case の名前のままです。

対応機能

  • フィールドの型: 数値 → Schema.Types.Number、true/false → Schema.Types.Boolean、2024-05-01 や 2024-05-01T09:30:00Z のような ISO 8601 文字列 → Schema.Types.Date、その他の文字列 → Schema.Types.String。
  • "01234" のように引用符で囲まれた数字は String のままなので、郵便番号や電話番号の先頭のゼロが消えません。
  • ネストしたオブジェクトは Schema.Types.Mixed になります。同じ種類の単純な値の配列は [Schema.Types.String] のような型付き配列に、それ以外は [Schema.Types.Mixed] になります。
  • required: true は、すべてのドキュメントに空でない値がある場合にだけ付きます。配列には付きません。Mongoose は欠けた配列を [] で埋めるからです。
  • エクスポートからコピーした _id キーは除外し、代わりにスキーマで _id: { type: Schema.Types.ObjectId, auto: true } を宣言します。
  • home-url のように JavaScript の識別子として無効なキーは、引用符付きのキーで書き出します。

利用シーン

Express + MongoDB API の最初のモデルファイル

フロントエンドとリクエストボディをすでに取り決めているなら、その JSON をスキーマの下書きにして、POST ルートの Comment.create(req.body) にすぐつなげられます。

スキーマなしで膨らんだコレクションの整理

strict: false やネイティブドライバーで埋められてきたコレクションからドキュメントをいくつか取り出してみましょう。常にあるフィールドと時々しかないフィールドが、required の有無としてすぐに見えてきます。

注意点と制限

  • モデルは mongoose.model('Comment', ...) として登録され、Mongoose はその名前を小文字・複数形にしてコレクション comments を選びます。既存のコレクションが別の名前なら、第3引数で指定してください。
  • Mixed のフィールドはその場での変更が追跡されません。ネストした値を編集したら save() の前に doc.markModified('profile') を呼ぶか、フィールドをサブスキーマに置き換えてください。
  • デフォルト値、インデックス、unique 制約は生成しません。検索に使うフィールドには unique: true や index: true を追加してください。

よくある質問

ES モジュールの構文(import / export default)で出力できますか?

このページが出力するのは require と module.exports を使う CommonJS だけです。"type": "module" のプロジェクトなら、最初の2行を import mongoose, { Schema } from 'mongoose' に、最後の行を export default Comment に変えてください。TypeScript や NestJS なら JSON → Mongoose (TS) のページを使ってください。

createdAt と updatedAt を自動で付けるには?

生成されるコードにはスキーマオプションがありません。第2引数を追加して new Schema({...}, { timestamps: true }) とすれば Mongoose が両方のフィールドを管理するので、JSON から来た同名のフィールドは削除してください。

required のフィールドに空文字列を保存するとどうなりますか?

Mongoose の文字列向け required バリデーターは "" を値なしとみなします。そのため、サンプルで空文字列だったフィールドには最初から required を付けずに生成しています。