Node.js x Express.js Backend APIs Example App

This is a working example of Node.js and Express.js App to explain the working of simple backend APIs. Created to explain how APIs work with express.

! important

Before running this app, use a random string as a secret value in your .env file.

• Please rename the example.env file to .env and then proceed with the following commands.

SECRET=     // any random string will work

Use either Insomnia API or Postman to get the cookie from server.

Use the following to signin:

{
    "username": "johndoe",
    "password": "password"
}

POST /signin : signin to the app

GET /all : get all employees

POST /add : add a new employee

DELETE /:id : deletes an employee

GET /ss : Get summary statistics

QUERY /ss : query the /ss with conditions "on_contract=true/false" Or call employees of a department or sub_department,

---

To get started run the following command and install dependencies:

$ npm run install

Run the development server:

$ npm run dev

Start the production server:

$ npm run start

Logging

Morgan package is used in this example for logging all the rquests in access.log file that is created automatically when the server is started. Please use the flag: 'r+' when going to production to retain all logs.

Container Image

A dockerfile is also available in case you want to containerize and ship it.

• Please note that this file works with windows and when using MacOS the path might not resolve.
• You can change the WORKDIR and COPY path that can resolve when containerizing the app.
• To build a containerized app use the following command.

docker build -t api-with-node:v1 .

Then run the container using the following command

docker run -p 8080:8080 -it api-with-node:v1

Prepared by : Navninder