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

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

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

new Schema({...}) で定義した JavaScript の Mongoose スキーマから、例となるドキュメントの JSON を作ります。スキーマ定義のオブジェクトそのものを解析するので、{ type: String, enum: [...] } や { type: Map, of: Number } のようなオプションや、他のスキーマ変数への参照もたどります。

Express + Mongoose の API の裏にあるコレクションをドキュメント化するときや、ドキュメントがどんな形をしているかをフロントエンドに説明するときに役立ちます。配列のサブドキュメントには _id が付くがネストしたパスには付かない、といった Mongoose 特有のルールもそのまま反映されます。

使い方

  1. Mongoose (JS) 欄にスキーマファイルを貼り付けます。サブスキーマが別の変数にある場合は、その定義も同じ入力に含めてください。
  2. 他のどのスキーマからも使われていないスキーマがルートのドキュメントになります。複数ある場合は、変数名をキーにして出力されます。
  3. 結果を確認し、コピーボタンでコピーします。

例

入力 (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 } }
);
出力 (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] はサブドキュメントの配列なので各要素に _id が付き、__v はトップレベルにだけあります。dimensions には type がないので _id のないネストしたパスとなり、Decimal128 は toJSON() の形である $numberDecimal で表示されます。timestamps オプションがフィールド名を created_at に変え、updatedAt を無効にしているので、日付のフィールドは1つだけです。

対応機能

  • ルートのドキュメントには _id と __v が付き、versionKey: "rev" による名前の変更や false も反映します。
  • [subSchema] や [{ name: String }] のような配列のサブドキュメントには、スキーマで { _id: false } を設定していない限り _id が付きます。
  • type のないネストしたオブジェクト(address: { city: String })は、_id のない普通のオブジェクトのままです。
  • enum の配列は最初の値を、{ type: Map, of: String } は {"key": ""} を、Schema.Types.Mixed は null を出力します。
  • Schema.Types.ObjectId はサンプルの ObjectId 文字列に、Decimal128 は {"$numberDecimal": "0"} になります。
  • timestamps: true だけでなく、{ createdAt: "created_at", updatedAt: false } のような詳細な設定も読み取ります。
  • スキーマ間の循環参照は null で打ち切ります。

利用シーン

正確さを保てるコレクションのドキュメント

README や Wiki にコレクションごとのドキュメント例を載せる場合、スキーマファイルから生成すれば、ドキュメントがコードからずれていくのを防げます。

サブドキュメントの `_id` に気づく

フロントエンドは、配列の各要素がそれぞれ _id を持っていることに気づかずに要素を比較しがちです。出力を見れば、どの階層に _id が現れるかがはっきりします。

populate 前のレスポンスを説明する

ref の付いたフィールドは、populate されるまでは単なる ObjectId 文字列です。populate() のあとでレスポンスがどう変わるかを説明するときの基準として出力を使えます。

注意点と制限

  • リテラルの default("active"、0、true)はサンプル値として使います。Date.now のような関数のデフォルトは実行しないので、そうしたフィールドには型ごとの仮の値が入ります。
  • ref の付いたフィールドは、populate されたオブジェクトではなく ObjectId 文字列のままです。
  • フィールドの値としてインラインで書いた new Schema({...}, { _id: false }) はその場で変換され、自身のオプションも反映されます。別のルートとして出てくることはありません。
  • virtual、toJSON の transform、getter、select: false は反映されません。

よくある質問

Decimal128 のフィールドがオブジェクトで出てくるのはなぜですか?

Mongoose の Decimal128 は toJSON() を通して {"$numberDecimal": "12.50"} としてシリアライズされます。数値や文字列で送っているなら、スキーマに getter や transform を追加し、出力もそれに合わせて編集してください。

TypeScript や NestJS のスキーマをここに貼り付けられますか?

@Schema() クラスやインターフェースは Mongoose (TS) → JSON のページで変換してください。このページが解析するのは new Schema() に渡す JavaScript のオブジェクトです。

ファイルに mongoose.model() しかなく、スキーマが別の場所にある場合は?

スキーマの定義が入力に含まれている必要があります。new Schema(...) の部分も一緒に貼り付けてください。