MVC Application

Software used for this sample of MVC application

• HTTPSERVLET https://docs.oracle.com/javaee/7/api/javax/servlet/http/HttpServlet.html
• mySQL https://www.mysql.com/it/ as a database service
• TOMCAT http://tomcat.apache.org/ as server web
• ECLIPSE EE https://www.eclipse.org/webtools/jee/ as IDE to develop the whole mvc application
• DOCKER https://www.docker.com/ to run mysql on a container
• POSTMAN https://www.postman.com/ to test rest-api

Steps to run the application

1. Set up docker

   • First is necessary to run mySQL docker container

   docker run --name mysql -e MYSQL_ROOT_PASSWORD=password_secret -d mysql -h
   docker start mysql
   

   • run inside the container and check ip address, in my case ip is 172.17.0.2

   • connect to db with

   mysql -h 172.17.0.2 -u root -p
   

   • init the db with

   mysql -h 172.17.0.2 -u root -p masterdb < initDB.sql
   

   initDB.sql initialize the database and it will create the relational tables needed to store the data. Some data will also be added. customers
   

   customerID	firstName	lastName	username	password	balance
   1	Giulio	Bianchini	admin	123456	0
   2	Dippy	Dawg	Pippo	123456	100
   3	Donald	Duck	Paperino	123456	200

   transactions
   

   transactionID	customerID	amount	purchase_date
   1	2	10	CURRENT_TIMESTAMP
   2	2	10	CURRENT_TIMESTAMP
   3	3	50	CURRENT_TIMESTAMP
   4	3	70	CURRENT_TIMESTAMP

   superadmins
   

   adminID	username
   1	admin

2. Open the project with eclipse EE

   • right click on the project name
   • select run as and then run on server in order to start the web server

REST-API

Login

POST /rest-api/login

Header	Type	Description
Authorization	string	Required. base64 encoding of username and password

Responses

{
    "message": string,
    "code": number
}

i.e. response of a correct login

{
    "message": "success",
    "code": 200
}

if the request fails, code 401 is returned

---

Transactions

GET rest-api/transactions

Header	Type	Description
Authorization	string	Required. username (only for debug, must be a token) a simple customer can only see his transactions, while the admin can see all of them

Parameter	Type	Description
page	number	Not Required. Use to get 25 element in order to paginate
lte	number	Not Required. (less then equal, filter parameter to get transaction with amount less then equal a value)
gte	number	Not Required. (greater then equal, filter parameter to get transaction with amount greater then equal a value)

Responses

{
    "message": string,
    "code": number,
    "page": number,
    "pages": number,
    "contents": Object[]
}

i.e. response of a correct get

{
    "message": "transactions",
    "code": 200,
    "page": 1,
    "pages": 1,
    "contents": [
        {
            "transactionID": 1,
            "customerID": 2,
            "amount": 10,
            "purchaseDate": "2020-12-10 23:29:49"
        },
        {
            "transactionID": 2,
            "customerID": 2,
            "amount": 20,
            "purchaseDate": "2020-12-10 23:29:49"
        }
    ]
}

if the request fails, code 500 is returned

---

POST rest-api/transactions

Body

{
    "transactionID": number,
    "customerID": string,
    "amount": string,
    "purchaseDate": number
}

Responses

{
    "message": string,
    "code": number,
}

i.e. response of a correct post

{
    "message": "transaction created",
    "code": 201
}

if the request fails, code 500 is returned

---

PUT rest-api/transactions

Body

{
    "transactionID": number,
    "customerID": string,
    "amount": string,
    "purchaseDate": number
}

Responses

{
    "message": string,
    "code": number,
}

i.e. response of a correct put

{
    "message": "transaction updated",
    "code": 201
}

if the request fails, code 404 is returned if the transaction does not exist, otherwise 500

---

DELETE rest-api/transactions

Parameter	Type	Description
id	number	Required Id of the transaction to delete

Responses

{
    "message": string,
    "code": number,
}

i.e. response of a correct delete

{
    "message": "transaction deleted",
    "code": 200
}

---

if the request fails, code 404 is returned if the transaction does not exist, otherwise 500

---

---

---

Customers

GET rest-api/customers

Parameter	Type	Description
page	number	Not Required. Use to get 25 element in order to paginate

Responses

{
    "message": string,
    "code": number,
    "page": number,
    "pages": number,
    "contents": Object[]
}

i.e. response of a correct get

{
    "message": "transactions",
    "code": 200,
    "page": 1,
    "pages": 1,
    "contents": [
        {
            "customerID": 1,
            "balance": 0.0,
            "username": "admin",
            "password": null,
            "firstName": "Giulio",
            "lastName": "Bianchini"
        },
        {
            "customerID": 2,
            "balance": 100.0,
            "username": "Pippo",
            "password": null,
            "firstName": "Dippy",
            "lastName": "Dawg"
        },
        {
            "customerID": 3,
            "balance": 200.0,
            "username": "Paperino",
            "password": null,
            "firstName": "Donald",
            "lastName": "Duck"
        }
    ]
}

if the request fails, code 500 is returned

---

POST rest-api/customers

Body

{
    "customerID": 0,
    "balance": 100,
    "firstName": "Giampiero",
    "lastName": "Rossi",
    "username": "GiampRos",
    "password": "123456"
}

Responses

{
    "message": string,
    "code": number,
}

i.e. response of a correct post

{
    "message": "customer created",
    "code": 201
}

if the request fails, code 500 is returned

---

PUT rest-api/customers

Body

{
    "customerID": 2,
    "balance": 100000,
    "firstName": "Giampiero",
    "lastName": "Rossi"
}

Responses

{
    "message": string,
    "code": number,
}

i.e. response of a correct put

{
    "message": "customer updated",
    "code": 201
}

if the request fails, code 404 is returned if the customer does not exist, otherwise 500

---

DELETE rest-api/customers

Parameter	Type	Description
id	number	Required Id of the customer to delete

Responses

{
    "message": string,
    "code": number,
}

i.e. response of a correct delete

{
    "message": "customer deleted",
    "code": 200
}

---

if the request fails, code 404 is returned if the customer does not exist, otherwise 500