Nodejs - Restful Api

Overview

Nodejs Restful API with jwt and mongodb Connection using mongoose.

Set Up Environment

First you need to have a mongodb installation. You can refer here to install an instance:

• Install MongoDB on Windows
• Install MongoDB on Mac OS
• Install MongoDB on Linux

Then install nodejs

• Nodejs Installation

After that you'll have access to yarn (Nodejs Package Manager). Now you can install additionnal dependencies

# Go inside the project
cd nodejs-restful-api

# Install all dependencies
yarn

# For nodejs live reload when file changes in the directory are detected install nodemon
npm  install -g nodemon

# You start the api by hitting
yarn
# Or
node server.js

Structure

Routes
    { get; }
    * Retrieve Informations about users
    - /users
    - /users/:id

    * Register informations or Login
    { post; }
    - /auth/register
    - /auth/login

    * Go to user profile
    { get; }
    - /auth/me
    
    * Edit user's informations
    { patch; }
    - /auth/edit

Models

User
    -_id [Generated]
    - name
    - surname
    - email
    - password
    * profile

Usefull Tips

• A guide for adding JWT token-based authentication
• Understanding JWT in Nodejs