Design and implement a REST API using Hibernate/Spring/SpringMVC (or Spring-Boot) without frontend.
The task is:
Build a voting system for deciding where to have lunch.
- 2 types of users: admin and regular users
- Admin can input a restaurant and it's lunch menu of the day (2-5 items usually, just a dish name and price)
- Menu changes each day (admins do the updates)
- Users can vote on which restaurant they want to have lunch at
- Only one vote counted per user
- If user votes again the same day:
- If it is before 11:00 we asume that he changed his mind.
- If it is after 11:00 then it is too late, vote can't be changed
Each restaurant provides new menu each day.
As a result, provide a link to github repository. It should contain the code, README.md with API documentation and couple curl commands to test it.
P.S.: Make sure everything works with latest version that is on github :)
P.P.S.: Asume that your API will be used by a frontend developer to build frontend on top of that.
Project is used HSQLDB database, providing some test data. Settings:
- database.url=jdbc:hsqldb:file:D:/temp/gradproject
- database.username=sa
- database.password=
- Guests can see restaurants and dishes for making decision where to lunch
- Only authorized users can vote where to lunch
- Admins use special methods to make menu and get information about users, who made decision where to lunch
Request to get list of all restaurants
Request example:
curl -s http://localhost:8080/rest/restaurants
Response:
[{"id":100005,"name":"Mangal","address":"Prospect Lenina, 20","cookery":"Azerbaijan","new":false},{"id":100007,"name":"Pizzburg","address":"Prospect Lenina, 29","cookery":"Italian","new":false},{"id":100006,"name":"Svoya kompanya","address":"Lesoparkovaya, 15","cookery":"Russian","new":false}]
Request to get restaurant by id
Request example:
curl -s http://localhost:8080/rest/restaurants/100007
Response:
{"id":100007,"name":"Pizzburg","address":"Prospect Lenina, 29","cookery":"Italian","new":false}
Request to get restaurant by name
Request example:
curl -s http://localhost:8080/rest/restaurants/by?name=Svoya%20kompanya
Response:
{"id":100006,"name":"Svoya kompanya","address":"Lesoparkovaya, 15","cookery":"Russian","new":false}
Request to get all restaurants with dishes for this day
Request example:
curl -s http://localhost:8080/rest/restaurants/todayDishes
Request returns a map with restaurants, that have menu for today.
Request to input a new restaurant
Request example:
curl -s -X POST -d '{"name":"Titanik","address":"Kutuzovskaya, 10","cookery":"European"}' -H 'Content-Type:application/json;charset=UTF-8' http://localhost:8080/rest/admin/restaurants/ --user [email protected]:admin
Response:
{"id":100033,"name":"Titanik","address":"Kutuzovskaya, 10","cookery":"European","new":false}
Request to update a restaurant
Request example:
curl -s -X PUT -d '{"id":100005,"name":"Mangal","address":"Prospect Lenina, 20","cookery":"Azerbaijan"}' -H 'Content-Type: application/json' http://localhost:8080/rest/admin/restaurants/ --user [email protected]:admin
Request to delete a restaurant
Request example:
curl -s -X DELETE http://localhost:8080/rest/admin/restaurants/100033 --user [email protected]:admin
Request to get actual menus for chosen restaurant
Request example:
curl -s http://localhost:8080/rest/restaurants/100006/dishes/actuals
Response:
{
"2018-05-31": [
{
"id": 100014,
"name": "Кофе",
"price": 50,
"date": [
2018,
5,
31
],
"new": false
},
{
"id": 100015,
"name": "Картошка фри",
"price": 110.9,
"date": [
2018,
5,
31
],
"new": false
},
{
"id": 100016,
"name": "Салат столичный",
"price": 221.2,
"date": [
2018,
5,
31
],
"new": false
}
],
"2018-09-30": [
{
"id": 100017,
"name": "Сок апельсиновый",
"price": 50,
"date": [
2018,
9,
30
],
"new": false
},
{
"id": 100018,
"name": "Гречка",
"price": 110.9,
"date": [
2018,
9,
30
],
"new": false
},
{
"id": 100019,
"name": "Котлеты",
"price": 221.2,
"date": [
2018,
9,
30
],
"new": false
},
{
"id": 100020,
"name": "Компот",
"price": 50,
"date": [
2018,
9,
30
],
"new": false
}
]
}
Request to get menus for chosen restaurant and date
Request example:
curl -s http://localhost:8080/rest/restaurants/100006/dishes/by?date=2018-09-30
Response:
[
{
"id": 100017,
"name": "Сок апельсиновый",
"price": 50,
"date": [
2018,
9,
30
],
"new": false
},
{
"id": 100018,
"name": "Гречка",
"price": 110.9,
"date": [
2018,
9,
30
],
"new": false
},
{
"id": 100019,
"name": "Котлеты",
"price": 221.2,
"date": [
2018,
9,
30
],
"new": false
},
{
"id": 100020,
"name": "Компот",
"price": 50,
"date": [
2018,
9,
30
],
"new": false
}
]
Request to get a dish by restaurant and id
Request example:
curl -s http://localhost:8080/rest/restaurants/100006/dishes/100014
Response:
{
"id": 100014,
"name": "Кофе",
"price": 50,
"date": [
2018,
5,
31
],
"new": false
}
Request to delete a dish by restaurant and id
Request example:
curl -s -X DELETE http://localhost:8080/rest/admin/restaurants/100005/dishes/100015 --user [email protected]:admin
Request to delete all dishes by restaurant
Request example:
curl -s -X DELETE http://localhost:8080/rest/admin/restaurants/100005/dishes --user [email protected]:admin
Request to create a dish
Request example:
curl -s -X POST -d '{"name": "Fried fish","price": 521.50,"date": [2018, 9, 29]}' -H 'Content-Type: application/json;charset=UTF-8' http://localhost:8080/rest/admin/restaurants/100007/dishes --user [email protected]:admin
Response:
{"id":100033,"name":"Fried fish","price":521.50,"date":[2018,9,29],"new":false}
Request to update a dish
Request example:
curl -s -X PUT -d '{"id": 100021,"name":"Salmon roasted","price":750.50,"date":[2018, 9, 29]}' -H 'Content-Type: application/json' http://localhost:8080/rest/admin/restaurants/100007/dishes --user [email protected]:admin
Request to get profile
Request example:
curl -s http://localhost:8080/rest/profile --user [email protected]:password
Response:
{
"id": 100000,
"name": "User",
"email": "[email protected]",
"registered": 1516177924656,
"enabled": true,
"role": "ROLE_USER",
"new": false
}
Request to update profile
Request example:
curl -s -X PUT -d '{"id":100000,"name":"newUser","email":"[email protected]","password":"newpass"}' -H 'Content-Type: application/json' http://localhost:8080/rest/profile --user [email protected]:password
Request to delete profile
Request example:
curl -s -X DELETE http://localhost:8080/rest/profile --user [email protected]:password
Request to get all users
Request example:
curl -s http://localhost:8080/rest/admin/users --user [email protected]:admin
Response:
[
{
"id": 100001,
"name": "Admin",
"email": "[email protected]",
"registered": 1516217507951,
"enabled": true,
"role": "ROLE_ADMIN",
"new": false
},
{
"id": 100000,
"name": "User",
"email": "[email protected]",
"registered": 1516217507951,
"enabled": true,
"role": "ROLE_USER",
"new": false
},
{
"id": 100002,
"name": "User_1",
"email": "[email protected]",
"registered": 1516217507951,
"enabled": true,
"role": "ROLE_USER",
"new": false
},
{
"id": 100003,
"name": "User_2",
"email": "[email protected]",
"registered": 1516217507951,
"enabled": true,
"role": "ROLE_USER",
"new": false
},
{
"id": 100004,
"name": "User_3",
"email": "[email protected]",
"registered": 1516217507951,
"enabled": true,
"role": "ROLE_USER",
"new": false
}
]
Request to get user by id
Request example:
curl -s http://localhost:8080/rest/admin/users/100004 --user [email protected]:admin
Response:
{"id":100004,"name":"User_3","email":"[email protected]","registered":1516217507951,"enabled":true,"role":"ROLE_USER","new":false}
Request to create user
Request example:
curl -s -X POST -d '{"name": "Created User","email": "[email protected]", "password":"createdUserPassword"}' -H 'Content-Type: application/json;charset=UTF-8' http://localhost:8080/rest/admin/users --user [email protected]:admin
Response:
{"id":100033,"name":"Created User","email":"[email protected]","registered":1516218030539,"enabled":true,"role":"ROLE_USER","new":false}
Request to create/update user via params
Request example:
curl -s -X POST -d "id=&name=postedUser&[email protected]&password=postedpass" http://localhost:8080/rest/admin/users/ajax --user [email protected]:admin
Request to delete user
Request example:
curl -s -X DELETE http://localhost:8080/rest/admin/users/100004 --user [email protected]:admin
Request to update user
Request example:
curl -s -X PUT -d '{"id":100003,"name":"newUser","email":"[email protected]","password":"newpass"}' -H 'Content-Type: application/json;charset=UTF-8' http://localhost:8080/rest/admin/users/100003 --user [email protected]:admin
Request to get user by email
Request example:
curl -s http://localhost:8080/rest/admin/users/[email protected] --user [email protected]:admin
Response:
{"id":100002,"name":"User_1","email":"[email protected]","registered":1516219862675,"enabled":true,"role":"ROLE_USER","new":false}
Request to enable user
Request example:
curl -s -X POST -d "enabled=false" http://localhost:8080/rest/admin/users/100004 --user [email protected]:admin
Request to vote for restaurant at current day
Request example:
curl -s -X POST http://localhost:8080/rest/votes/restaurants/100007 --user [email protected]:password
Request to vote for restaurant at chosen day
curl -s -X POST http://localhost:8080/rest/votes/restaurants/100007/dishes/2020-10-11 --user [email protected]:password
Request to delete(cancel) vote for chosen day
curl -s -X DELETE http://localhost:8080/rest/votes/2020-10-11 --user [email protected]:password
Request to get vote for chosen day
curl -s http://localhost:8080/rest/votes/2017-06-21 --user [email protected]:password
Response:
{
"primaryKey": {
"user": {
"id": 100000,
"name": "User",
"email": "[email protected]",
"registered": 1516222442467,
"enabled": true,
"role": "ROLE_USER",
"new": false
},
"date": [
2017,
6,
21
]
},
"restaurant": {
"id": 100005,
"name": "Nar-Sharab",
"address": "Naberejnaya, 121",
"cookery": "Caucasian",
"new": false
}
}
Request to get all your votes
Request example:
curl -s http://localhost:8080/rest/votes/user --user [email protected]:admin
Response:
[
{
"primaryKey": {
"user": {
"id": 100001,
"name": "Admin",
"email": "[email protected]",
"registered": 1516222442467,
"enabled": true,
"role": "ROLE_ADMIN",
"new": false
},
"date": [
2017,
6,
21
]
},
"restaurant": {
"id": 100005,
"name": "Nar-Sharab",
"address": "Naberejnaya, 121",
"cookery": "Caucasian",
"new": false
}
},
{
"primaryKey": {
"user": {
"id": 100001,
"name": "Admin",
"email": "[email protected]",
"registered": 1516222442467,
"enabled": true,
"role": "ROLE_ADMIN",
"new": false
},
"date": [
2018,
5,
31
]
},
"restaurant": {
"id": 100006,
"name": "Svoya kompanya",
"address": "Lesoparkovaya, 15",
"cookery": "Russian",
"new": false
}
}
]
Request to count votes for this restaurant
Request example:
curl -s http://localhost:8080/rest/votes/restaurants/100005/count --user [email protected]:password
Response:
3
Request to count all votes
Request example:
curl -s http://localhost:8080/rest/votes/countAll --user [email protected]:password
Response:
8
Request to get users decided to lunch this restaurant and date
Request example:
curl -s http://localhost:8080/rest/admin/votes/restaurants/100005/usersBy?date=2017-06-21 --user [email protected]:admin
Response:
[
{
"id": 100000,
"name": "User",
"email": "[email protected]",
"registered": 1516222442467,
"enabled": true,
"role": "ROLE_USER",
"new": false
},
{
"id": 100001,
"name": "Admin",
"email": "[email protected]",
"registered": 1516222442467,
"enabled": true,
"role": "ROLE_ADMIN",
"new": false
},
{
"id": 100002,
"name": "User_1",
"email": "[email protected]",
"registered": 1516222442468,
"enabled": true,
"role": "ROLE_USER",
"new": false
}
]
Request to get votes for chosen restaurant between dates
Request example:
curl -s --user [email protected]:admin "http://localhost:8080/rest/admin/votes/restaurants/100007/between?startDate=2017-10-10&endDate=2017-10-12"
Response:
[
{
"primaryKey": {
"user": {
"id": 100000,
"name": "User",
"email": "[email protected]",
"registered": 1516228451327,
"enabled": true,
"role": "ROLE_USER",
"new": false
},
"date": [
2017,
10,
11
]
},
"restaurant": {
"id": 100007,
"name": "Pizzburg",
"address": "Prospect Lenina, 29",
"cookery": "Italian",
"new": false
}
},
{
"primaryKey": {
"user": {
"id": 100002,
"name": "User_1",
"email": "[email protected]",
"registered": 1516228451327,
"enabled": true,
"role": "ROLE_USER",
"new": false
},
"date": [
2017,
10,
12
]
},
"restaurant": {
"id": 100007,
"name": "Pizzburg",
"address": "Prospect Lenina, 29",
"cookery": "Italian",
"new": false
}
}
]
Request to get votes for restaurant and date
Request example:
curl -s --user [email protected]:admin "http://localhost:8080/rest/admin/votes/restaurants/100006/by?date=2018-05-31"
Response:
[
{
"primaryKey": {
"user": {
"id": 100000,
"name": "User",
"email": "[email protected]",
"registered": 1516228451327,
"enabled": true,
"role": "ROLE_USER",
"new": false
},
"date": [
2018,
5,
31
]
},
"restaurant": {
"id": 100006,
"name": "Svoya kompanya",
"address": "Lesoparkovaya, 15",
"cookery": "Russian",
"new": false
}
},
{
"primaryKey": {
"user": {
"id": 100001,
"name": "Admin",
"email": "[email protected]",
"registered": 1516228451327,
"enabled": true,
"role": "ROLE_ADMIN",
"new": false
},
"date": [
2018,
5,
31
]
},
"restaurant": {
"id": 100006,
"name": "Svoya kompanya",
"address": "Lesoparkovaya, 15",
"cookery": "Russian",
"new": false
}
}
]