new Schema({...})로 정의한 JavaScript Mongoose 스키마에서 도큐먼트 예시 JSON을 만듭니다. 스키마 정의 객체를 직접 읽기 때문에 { type: String, enum: [...] }, { type: Map, of: Number } 같은 옵션과 다른 스키마 변수 참조까지 따라갑니다.
Express + Mongoose로 만든 API에서 컬렉션 구조를 문서화하거나, 프런트엔드가 받을 도큐먼트 모양을 설명할 때 씁니다. 배열 서브도큐먼트에 _id가 붙는지, 중첩 경로에는 안 붙는지 같은 Mongoose 고유 규칙이 그대로 반영됩니다.
Mongoose (JS) 칸에 스키마 파일을 붙여넣습니다. 서브스키마를 변수로 분리했다면 그 정의도 같은 입력에 넣어 주세요.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 } }
);{
"_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: false로 꺼서 날짜 필드는 하나입니다.
_id와 __v를 붙이고, versionKey: "rev"처럼 이름을 바꾸거나 false로 끈 설정을 따릅니다.[subSchema]나 [{ name: String }] 같은 배열 서브도큐먼트에는 _id를 붙이고, { _id: false } 옵션이면 뺍니다.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나 사내 위키에 컬렉션별 도큐먼트 예시를 붙일 때, 스키마 파일에서 바로 뽑아 실제와 어긋나지 않게 유지할 수 있습니다.
배열 항목마다 _id가 생기는 것을 모르고 프런트엔드에서 키 없이 비교하다 문제가 생기는 경우가 많습니다. 결과를 보면 어느 단계에 _id가 붙는지 명확히 보입니다.
ref가 있는 필드는 populate 전에는 ObjectId 문자열입니다. populate 전후로 응답이 어떻게 다른지 설명할 때 출발점으로 씁니다.
default가 리터럴("active", 0, true)이면 그 값을 예시 값으로 씁니다. Date.now 같은 함수 기본값은 실행하지 않으므로 타입별 예시 값이 들어갑니다.ref가 있어도 populate된 객체가 아니라 ObjectId 문자열로 둡니다.new Schema({...}, { _id: false })도 그 자리에서 변환되고 자기 옵션을 따릅니다. 별도 최상위 항목으로 따로 나오지 않습니다.toJSON transform, getter, select: false는 반영하지 않습니다.Mongoose의 Decimal128 값은 toJSON()에서 {"$numberDecimal": "12.50"} 모양이 됩니다. 응답에서 숫자나 문자열로 보내려면 스키마에 getter나 transform을 두고, 결과도 그에 맞게 고쳐 주세요.
@Schema() 클래스나 인터페이스는 Mongoose (TS) → JSON 페이지에서 변환하세요. 이 페이지는 new Schema()에 넘긴 JavaScript 객체를 읽습니다.
mongoose.model()만 있고 스키마가 다른 파일에 있으면요?스키마 정의가 입력에 있어야 합니다. 스키마를 만드는 new Schema(...) 부분을 같이 붙여넣으세요.