Node, Express, MongoDB and Mongoose Reference Based Relationships (Normalization)

Overview

This is an easy, basic and raw example of HOW to implement Reference Based Relationships (Normalization) with Mongoose.

For a dryer approach, check Generic Controllers.

Requirements

• Node 12+
• NPM
• MongoDB
• Mongoose ODM
• Optional: MongoDB account

Install dependencies

npm install

Running the server

Development

npm run dev

Production

npm run build

npm start

API endpoints

GET /api/artists

• Returns an object with the key data containing an array of objects with 40 records (max).
• Supports query string:
  • ?limit=integer
  • ?offset=integer

Request:

curl http://127.0.0.1:3000/api/artists

Sample response:

{
  "data": [
    {
      "_id": "6206ad6f6dcc7026ff2a19cd",
      "name": "Guns N' Roses",
      "__v": 0
    }
  ]
}

POST /api/artists

• Returns the newly created object (aka, artist).
• The server only accepts a payload with the property name.

Request:

curl -X POST http://127.0.0.1:3000/api/artists -d '{"name":"Radiohead"}' -H "Content-Type: application/json"

Sample response:

{
  "_id": "6206d43f79e6a14bb0f830d5",
  "name": "Radiohead",
  "__v": 0
}

GET /api/songs

• Returns an object with the key data containing an array of objects with 40 records (max).
• Supports query string:
  • ?limit=integer
  • ?offset=integer

Request:

curl http://127.0.0.1:3000/api/songs

Sample response:

{
  "data": [
    {
      "_id": "6206ada46dcc7026ff2a19d1",
      "name": "Sweet Child O' Mine",
      "artist": {
        "_id": "6206ad6f6dcc7026ff2a19cd",
        "name": "Guns N' Roses"
      }
    },
    {
      "_id": "6206adb26dcc7026ff2a19d3",
      "name": "Knockin' On Heaven's Door",
      "artist": {
        "_id": "6206ad6f6dcc7026ff2a19cd",
        "name": "Guns N' Roses"
      }
    }
  ]
}

POST /api/songs

• Returns the newly created object (aka, song).
• The server only accepts a payload with the properties name and artist.

IMPORTANT: You have to pass a valid MongoDB ObjectId which should be the _id of an existent artist.

Request:

curl -X POST http://127.0.0.1:3000/api/songs -d '{"name":"No surprises", "artist": "6206d43f79e6a14bb0f830d5"}' -H "Content-Type: application/json"

Sample response:

{
  "_id":"6206d51679e6a14bb0f830d7",
  "name":"No surprises",
  "artist":"6206d43f79e6a14bb0f830d5",
  "__v":0
}

GET everything else

• Any other endpoint will retrieve an object

Request:

curl http://127.0.0.1:3000/

Response:

{
  "message": "Node.js, Express, MongoDB and Mongoose Normalization!"
}