COMP $3123$ Full Stack Development $$ I

$$ Instructions:

You are required to implement the following RESTful API endpoints. Ensure

that each endpoint performs the correct operation and returns the specified

response code.

$$ Objectives:

$1.$ Understand RESTful API design principles.

$2.$ Implement CRUD operations using provided API endpoints.

$3.$ Test the API endpoints to ensure they return the correct response codes

and data.

As a newly hired Jr$.$ Software Engineer my manager assigned me a task to

develop Backend application using NodeJS, Express and MongoDB. He also

wants me to apply my VCS $($GitHub$)$ skills to develop these projects where I

will commit and push all my code to Student#$\_$COMP$3123\_$Assignment$1$

repository.

$$ API Endpoints to Implement:

Following is the list of APIs to develop which accept all data as JSON Object

whenever needed:

Sr$.$

#

Method Endpoint Response

Code Description

User Management:

$1$ POST $/$api$/$v$1/$user$/$signup $201$

Allow user to

create new

account

$2$ POST $/$api$/$v$1/$user$/$login $200$

Allow user to

access the

system

Employee Management:

$3$ GET $/$api$/$v$1/$emp$/$employees $200$

User can get

all employee

list

$4$ POST $/$api$/$v$1/$emp$/$employees $201$

User can

create new

employee

$5$ GET $/$api$/$v$1/$emp$/$employees$/\{$eid$\}200$

User can get

employee

details by

employee id

$6$ PUT $/$api$/$v$1/$emp$/$employees$/\{$eid$\}200$

User can

update

employee

details

$7$ DELETE $/$api$/$v$1/$emp$/$employees$?$eid$=$xxx $204$

User can

delete

employee by

employee id

$$ MongoDB Database name: comp$3123\_$assigment$1$

Users Collection Schema

$\{$

$"\_$id$"$: ObjectId,

"username": String,

"email": String,

"password": String, $//$ This should be hashed

"created$\_$at$"$: Date,

"updated$\_$at$"$: Date

$\}$

User can login using username$/$email and password

Employee Collection Schema:

$\{$

$"\_$id$"$: ObjectId,

"first$\_$name": String,

"last$\_$name": String,

"email": String,

"position": String,

"salary": Number,

"date$\_$of$\_$joining": Date,

"department": String,

"created$\_$at$"$: Date,

"updated$\_$at$"$: Date

$\}$

$$ Sample Input and Output:

API Sample Input Sample Output

POST $/$api$/$v$1/$user$/$signup $\{$

"username":

"johndoe",

"email":

"johndoe@exampl

e$.$com",

"password":

"password$123"$

$\}$

$\{$

"message":

"User created

successfully.",

"user$\_$id$"$:

$"64$c$9$e$5$a$3$d$9$f$3$c$1$

a$5$c$9$b$4$e$8$a$1"$

$\}$

POST $/$api$/$v$1/$user$/$login $\{$

"email":

"johndoe@exampl

e$.$com",

"password":

"password$123"$

$\}$

$\{$

"message":

"Login

successful.",

$$jwt$\_$token$$:

$$Optional

implementation$$

$\}$

GET $/$api$/$v$1/$emp$/$employees $[$

$\{$

"employee$\_$id$"$:

$"64$c$9$e$5$a$3$d$9$f$3$c$1$

a$5$c$9$b$4$e$8$a$2",$

"first$\_$name":

"Jane",

"last$\_$name":

"Doe",

"email":

"jane.doe@exampl

e$.$com",

"position":

"Software

Engineer",

"salary":

$90000,$

"date$\_$of$\_$joining":

$"2023-08-$

$01$T$00$:$00$:$00\mathrm{.}000$

Z$",$

"department":

"Engineering"

$\},$

$\{$

"employee$\_$id$"$:

$"64$c$9$e$5$a$3$d$9$f$3$c$1$

a$5$c$9$b$4$e$8$a$3",$

"first$\_$name":

"John",

"last$\_$name":

"Smith",

"email":

"john.smith@exa

mple.com",

"position":

"Product

Manager",

"salary":

$110000,$

"date$\_$of$\_$joining":

$"2023-07-$

$15$T$00$:$00$:$00\mathrm{.}000$

Z$",$

"department":

"Product"

$\}$

$]$

POST $/$api$/$v$1/$emp$/$employees $\{$

"first$\_$name":

"Alice",

"last$\_$name":

"Johnson",

"email":

"alice.johnson@ex

ample.com",

"position":

"Designer",

"salary":

$85000,$

"date$\_$of$\_$joining":

$"2023-08-$

$10$T$00$:$00$:$00\mathrm{.}000$

Z$",$

"department":

"Design"

$\}$

$\{$

"message":

"Employee

created

successfully.",

"employee$\_$id$"$:

$"64$c$9$e$5$a$3$d$9$f$3$c$1$

a$5$c$9$b$4$e$8$a$4"$

$\}$

GET

$/$api$/$v$1/$emp$/$employees$/64$c$9$e$5$a

$3$d$9$f$3$c$1$a$5$c$9$b$4$e$8$a$4$

$\{$

"employee$\_$id$"$:

$"64$c$9$e$5$a$3$d$9$f$3$c$1$

a$5$c$9$b$4$e$8$a$4",$

"first$\_$name":

"Alice",

"last$\_$name":

"Johnson",

"email":

"alice.johnson@ex

ample.com",

"position":

"Designer",

"salary":

$85000,$

"date$\_$of$\_$joining":

$"2023-08-$

$10$T$00$:$00$:$00\mathrm{.}000$

Z$",$

"department":

"Design"

$\}$

PUT

$/$api$/$v$1/$emp$/$employees$/\{$eid$\}$

$\{$

"position":

"Senior

Designer",

"salary": $95000$

$\}$

$\{$

"message":

"Employee details

updated

successfully."

$\}$

DELETE

$/$api$/$v$1/$emp$/$employees$?$eid$=64$c

$9$e$5$a$3$d$9$f$3$c$1$a$5$c$9$b$4$e$8$a$4$

$\{$

"message":

"Employee deleted

successfully."

$\}$

$$ Testing & Validation

$1.$ Validation:

o Use libraries like express$-$validator to validate incoming

requests.

$2.$ Testing with Postman:

o Test all API endpoints and save the Postman collection.

o Capture screenshots of each test.

Sample Error Response:

$\{$

$$status$$: false,

$$message$$: $$Invalid Username and password$$

$\}$

$$ Notes:

$-$ Make use of express.Routes$()$ and modules

$-$ Validate the data whenever required

$-$ Return error details or success response details whenever required

$-$ All data must be sent back and forth in JSON Object format

$-$ Optionally apply JWT security concept to secure all your API calls