FLASK MYSQL RESTAPI is a dockerized application to store, backup, publish and perform ABM functions on hiring people for different departments and jobs. It also publishes some statistics on this data. Use HTTP protocol and the GET, POST, PUT and DELETE methods. Publish various services through a Python Flask API, using a MySql database.
You will need python installed and a running MySql database on port 3306, with the credentials from the ./config.py file
or can create a docker only for this MySql db whit this line:
docker run --name mysql-db -e MYSQL_ROOT_PASSWORD=StudiodeDataenGlobant -p 3307:3306 -d mysql:latestFor the python part of the application from the root directory of the project run the following scripts
$ pip install -r requirements.txt$ python src/app.pyYou will need to have docker and docker compose installed.
From the root directory of the project run the following scripts
```bash
docker-compose up
```
in both cases you can now point to http://localhost:5000/ to use the different services of the application
The calls to the different services are made through the URL "http;//localhost:5000/" adding the service and the variables to send if necessary.
This service is used to import data from a .CSV file (an example of the name historical_data.csv is included in the code repository)
A clarification that applies to all registrations for new employees, both the department and
the job are always passed in text and the application search for the department or job, if
it does not find it in the table it adds it and if it finds it it puts the id that it already had.This file should have the values separated by commas "," following the example below:
4535,Marcelo Gonzalez,2021-01-28T16:02:08Z, Fisheries Department, Sailor,
4572,Lidia Mendez,2021-03-28T16:01:28Z, National Bank, Accountant,
4545,Angel buttler,2021-05-28T16:02:08Z, Supply chain, Stock Handler Sr,
...the name of the file to use is passed in the end of URL, call following the example:
http://localhost:5000/import_historic_CSV/historical_data.csvexample response return:
{
"error cases: ": [
{
"Error": "ID: 4535 already exists, cannot be duplicated.",
"datetime": "2021-01-28T16:02:08Z",
"department_id": 7,
"id": 4535,
"job_id": 8,
"name": "Marcelo Gonzalez"
},
{
"Error": "ID: 4572 already exists, cannot be duplicated.",
"datetime": "2021-03-28T16:01:28Z",
"department_id": 9,
"id": 4572,
"job_id": 10,
"name": "Lidia Mendez"
}
],
"import historic CSV message": "1 historical employees added and 2 invalid parameters cases were detected.",
"success": false
}Service that by GET method returns a list of hired employees in JSON format as the following example: Call: http://localhost:5000/hired_employees example response return:
{
"hired_employees": [
{
"datetime": "2022-12-28T16:02:08Z",
"department_id": 1,
"id": 2,
"job_id": 1,
"name": "john Hand"
}
],
"message": "hired_employees list.",
"success": true
}Service that by GET method returns a list of departments in JSON format as the following example: Call: http://localhost:5000/departments example response return:
{
"departments": [
{
"department": "Fire Station",
"id": 1
}
],
"message": "departments list.",
"success": true
}Service that by GET method returns a list of jobs in JSON format as the following example: Call: http://localhost:5000/jobs example response return:
{
"jobs": [
{
"department": " Sailor",
"id": 1
}
],
"message": "jobs list.",
"success": true
}Service that registers an employee by posting a JSON with the format of the example.
A clarification that applies to all registrations for new employees, both the department and
the job are always passed in text and the application search for the department or job, if
it does not find it in the table it adds it and if it finds it it puts the id that it already had.Call: http://localhost:5000/hired_employee POST call json example:
{
"id": 2,
"name": "john Hand",
"datetime": "2022-12-28T16:02:08Z",
"department": "fire station",
"job": "adminitrator"
}example response return:
{
"message": "ID already exists, cannot be duplicated.",
"success": false
}Service that registers up to 1000 employees at once, posting a JSON with the format of the following example. This service returns a Jason with the error cases and a detail of why each one was rejected.
A clarification that applies to all registrations for new employees, both the department and
the job are always passed in text and the application search for the department or job, if
it does not find it in the table it adds it and if it finds it it puts the id that it already had.Call: http://localhost:5000/hired_employees POST call json example:
[
{
"name": "Belinda Machintons",
"datetime": "2020-11-28T16:02:08Z",
"department": "hospital",
"id": 4,
"job": "Nurse"
},
{
"name": "Cecil keenan",
"datetime": "2020-11-28T16:02:08Z",
"department": "Sap Company",
"id": 5,
"job": "Deal Execution Bussiness Manager"
},
{
"name": "Jhonatan Tole",
"datetime": "2020-14-28T16:02:08Z",
"department": "Hsbc Bank",
"id": 6,
"job": "Mainframe Developer Sr."
}
]example response return:
{
"error cases: ": "(
{
'name': 'johny Ball',
'datetime': '2018-12-28T16:02:08Z',
'department': 'fire station',
'id': 6, 'job': 'Sr fireman',
'Error': 'ID: 6 already exists, cannot be duplicated.'},
{
'name': 'Belinda Machintons',
'datetime': '2020-11-28T16:02:08Z',
'department': 'hospital',
'id': 4,
'job': 'Nurse',
'Error': 'ID: 4 already exists, cannot be duplicated.'
},
{
'name': 'Jhonatan Tole',
'datetime': '2020-14-28T16:02:08Z',
'department': 'Hsbc Bank',
'id': 6, 'job':
'Mainframe Developer Sr.',
'Error': 'ID: 6 already exists, cannot be duplicated.'
})",
"message": "1 new employees added and 3 invalid parameters cases were detected.",
"success": true
}Service that update an employee information by posting a JSON with the format of the example.
A clarification, both the department and the job are always passed in text and the application
search for the department or job, if it does not find it in the table it adds it and if it
finds it it puts the id that it already had.Call: http://localhost:5000/hired_employees PUT call json example:
{
"name": "Jhonatan Tole",
"datetime": "2021-13-28T16:02:08Z",
"department": "Hsbc Bank",
"id": 6,
"job": "Mainframe Developer Sr."
}example response return:
{
"message": "hired employee updated.",
"success": true
}Service to delete an employee, by posting a JSON with the format of the example. Call: http://localhost:5000/hired_employees DELETE call json example:
{
"id": 6
}example response return:
{
"message": "hired employee deleted.",
"success": true
}Service to generate backup file in AVRO format from all DB data with time stamp in the file name POST Call: http://localhost:5000/avro_backup
Right now no input JSON is being sent but, this backups relational task could have some security key
to avoid malicious callsexample response return:
{
"Avro backup": "save",
"file name": "backups/hired_employees_backup-01-05-2023-10-56-53.avro",
"success": true
}Service to generate backup file in AVRO format from all DB data with time stamp in the file name POST Call: http://localhost:5000/avro_backup_list
Right now no input JSON is being sent but, this backups relational task could have some security key
to avoid malicious callsexample response return:
{
"Avro backup files list": [
"hired_employees_backup-01-02-2023-12-15-50.avro",
"hired_employees_backup-01-02-2023-14-09-20.avro",
"hired_employees_backup-01-02-2023-15-27-21.avro",
"hired_employees_backup-01-05-2023-11-04-42.avro"
],
"success": true
}Service restore backup in to data base from avro backup file. This service returns a Jason with the error cases and a detail of why each one was rejected.
WARNING, this action clean all data in DB and leave only data in backup avro file (this action is very sensitive
and in production this action would require much more security).
This backups relational task could have some security key to avoid malicious callsCall: http://localhost:5000/avro_backup_restore POST call json example:
{
"file": "hired_employees_backup-01-05-2023-11-04-42.avro"
}example response return:
{
"Avro backup restored message": "25 new employees added.",
"success": true
}This service returns the number of employees hired for each job and department during the consulted Year and divided by Quarter in alphabetical order by department and job Call: http://localhost:5000/hires_by_Q_for_year/YEAR call URL example:
http://localhost:5000/hires_by_Q_for_year/2021example response return:
{
"Count hired_employees by Q for year": [
{
"Q1": 1,
"Q2": 6,
"Q3": 23,
"Q4": 9,
"department": " Basquetball",
"job": " GOAT"
},
{
"Q1": 2,
"Q2": 7,
"Q3": 17,
"Q4": 32,
"department": " Basquetball",
"job": " Legend Player"
},
{
"Q1": 8,
"Q2": 45,
"Q3": 2,
"Q4": 0,
"department": " Fisheries Department",
"job": " Fisherman"
},
{
"Q1": 9,
"Q2": 67,
"Q3": 45,
"Q4": 13,
"department": " Fisheries Department",
"job": " Sailor"
}
],
"message": "Count hired_employees by Q for year, report OK.",
"success": true
}
This service lists the number of employees hired by each department that has hired more employees than the average of all the departments for the year consulted, ordered by number of employees in descending order. Call: http://localhost:5000/hires_by_department_having_more_than_mean/YEAR call URL example:
http://localhost:5000/hires_by_department_having_more_than_mean/2021example response return:
{
"Count hired_employees count of hires employees by department having more than the mean for year": [
{
"department": " Fisheries Department",
"hired": 3,
"id": 7
},
{
"department": "Fire Station",
"hired": 2,
"id": 1
},
{
"department": "Hospital",
"hired": 2,
"id": 2
},
{
"department": " Basquetball",
"hired": 2,
"id": 4
},
{
"department": "Sap Department",
"hired": 2,
"id": 6
},
{
"department": " Staff",
"hired": 2,
"id": 10
}
],
"message": "Count hired_employees count of hires employees by department having more than the mean for year, report OK.",
"success": true
}
The LogFile(text) function receives the text to be logged and generates a file per day in the /logs folder with the name of the current date as in the following example:
log_01-05-2023.txtin this file a record is kept for each API call with data about the input and output calls.
React
Typescript
Django
Laravel
Facebook
Microsoft
Google
Alibaba
D3
Tencent