Node, Express and MongoDB
Overview
This is an easy, basic and raw example of HOW to implement an API with Node, Express and MongoDB/Atlas (with Mongoose ODM).
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/users
- Returns an object with the key data containing an array of objects with
40 records. - Supports query string:
- ?limit=integer
- ?offset=integer
Request:
curl http://127.0.0.1:3333/api/users
Sample response:
{
"data": [
{
"_id": "60da6b74fc13ae7069000d4b",
"firstname": "Dedra",
"lastname": "Demangel",
"age": 96,
"gender": "Agender",
"username": "ddemangel3",
"company": "Skidoo",
"email": "[email protected]",
"phone": "759-142-2883",
"address": "4 Fisk Drive"
},
{
"_id": "60da6b74fc13ae7069000d48",
"firstname": "Martynne",
"lastname": "Pimmocke",
"age": 79,
"gender": "Female",
"username": "mpimmocke0",
"company": "Edgeify",
"email": "[email protected]",
"phone": "354-508-5487",
"address": "20633 Stone Corner Trail"
}
]
}Query string
GET /api/users?limit=1
- Returns
nrecord(s) wherenis the value (type: Number) of thelimitkey.
Request:
curl http://127.0.0.1:3333/api/users?limit=1
Response:
{
"data": [
{
"_id": "60da6b74fc13ae7069000d4b",
"firstname": "Dedra",
"lastname": "Demangel",
"age": 96,
"gender": "Agender",
"username": "ddemangel3",
"company": "Skidoo",
"email": "[email protected]",
"phone": "759-142-2883",
"address": "4 Fisk Drive"
}
]
}Wrong type for n value will return all the users.
Example: users?limit=%27Hello%27
GET /api/users?offset=10
- Returns from
n(PRIMARY KEY) wherenis the value (type: Number) of theoffsetkey.
Request:
curl http://127.0.0.1:3333/api/users?offset=10
Response:
{
"data": [
{
"_id": "60da6b74fc13ae7069000d55",
"firstname": "Cindi",
"lastname": "Harnell",
"age": 57,
"gender": "Bigender",
"username": "charnelld",
"company": "Skyble",
"email": "[email protected]",
"phone": "176-961-8815",
"address": "09953 Susan Alley"
},
{
"_id": "60da6b74fc13ae7069000d57",
"firstname": "Olva",
"lastname": "Hoodless",
"age": 61,
"gender": "Female",
"username": "ohoodlessf",
"company": "Jaloo",
"email": "[email protected]",
"phone": "886-598-0586",
"address": "8 Chinook Pass"
}
]
}GET /latency
- Returns an object with a delay of 1 second (default)
- Supports query string:
- ?limit=integer
- ?offset=integer
Request:
curl http://127.0.0.1:3333/latency
Response:
{
"data": "Thanks for waiting 1 second"
}Query string
GET /latency?delay=2000
- Increases latency (delay) to
nmilliseconds where, min:1000 and max:4000. Default value: 1000ms.
Wrong type for n value will produce a default delay of 1000ms.
Request:
curl http://127.0.0.1:3333/latency?delay=2000
Response:
{
"data": "Thanks for waiting 2 seconds"
}GET everything else
- Any other endpoint will retrieve an object
Request:
curl http://127.0.0.1:3333/
Response:
{
"message": "Node.js, Express, and MongoDB API!"
}Notes:
If you need help at the tie of Migrating from mLab to MongoDB Atlas
![greenkeeper[bot] avatar](https://avatars.githubusercontent.com/in/505?v=4 "greenkeeper[bot]")
The build
The build
React
Typescript
Django
Laravel
Facebook
Microsoft
Google
Alibaba
D3
Tencent