REST API starter

This application is the start point for Sprint 1000 of the Lloyds Bank Group Modern Engineering Bootcamp Project Specification.

Installation

To initialise the project you will need to install several dependencies, open up a git bash terminal from the repo directory and run the command:

$ npm install

Running the application

In order to run the application, from your git bash terminal run:

$ npm start
API Listening on http://localhost:8080

Stopping the application

In order to stop the application from the git bash terminal that is running the server press CTRL + C

Running on a different port

To start the application on an alternative port to the default (8080) from your git bash terminal run:

$ PORT=9090 npm start
API Listening on http://localhost:9090

Functionality

Through the browser

In order to interact with this application through a browser navigate to http://localhost:8080/ or change the port number to the alternative that you have used.

There is a full CRUD functionality through the buttons on the web page.

CREATE

To create the example product run the command:

$ curl -s -X POST http://localhost:8080/create -H 'Content-type:application/json' -d '{"name":"example product", "description":"this is an example", "price":9.99}'

READ (all)

To read all of the products run the command:

$ curl -s -X GET http://localhost:8080/read

READ (one)

To read one of the products run the command:

$ curl -s -X GET http://localhost:8080/read/<id>

n.b: For these commands anything surrounded by angled braces <> needs to be replaced by you

UPDATE

To update one of the products run the command:

$ curl -s -X PUT http://localhost:8080/update/<id> -H 'Content-type:application/json'  -d '{"name":"updated product", "description":"its brand new", "price":99.99}'

n.b: For these commands anything surrounded by angled braces <> needs to be replaced by you

DELETE

To delete one of the products run the command:

$ curl -s -X DELETE http://localhost:8080/delete/<id>

n.b: For these commands anything surrounded by angled braces <> needs to be replaced by you

---