Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/rashevskiivv/cybeat-api

Last synced: about 1 month ago
JSON representation

Host: GitHub
URL: https://github.com/rashevskiivv/cybeat-api
Owner: rashevskiivv
Created: 2022-09-27T18:53:21.000Z (over 2 years ago)
Default Branch: main
Last Pushed: 2022-10-18T14:29:16.000Z (about 2 years ago)
Last Synced: 2023-07-14T11:24:47.542Z (over 1 year ago)
Language: Kotlin
Size: 109 KB
Stars: 0
Watchers: 1
Forks: 0
Open Issues: 0
Metadata Files:
- Readme: README.MD

Awesome Lists containing this project

README

# Cybeat-API
[Category](#Category)

[Customer](#Customer)

[Dish](#Dish)

[Order](#Order)

## Category
### API call
> GET https://cybeat-api.herokuapp.com/category
>
Headers: "Accept: application/json"
#### Response
> List of categories
```json
[
{
"id": 1,
"name": "Sushi"
},
{
"id": 2,
"name": "Pizza"
}
]
```
***

### API call
> GET https://cybeat-api.herokuapp.com/category/{id}
>
Headers: "Accept: application/json"
#### Parameters
`id` required | type: `Integer` - Id of category
#### Example
> GET https://cybeat-api.herokuapp.com/category/1
>
Accept: application/json
#### Response
> Category with specified id as below
```json
{
"id": 1,
"name": "Sushi"
}
```
> Or message about operation from list below
```text
No "id" field in body of request
No category with id 1
```
***

### API call
> POST https://cybeat-api.herokuapp.com/category
>
Headers: "Accept: application/json"
#### Body
`json object` which contains:

* `name` required | type: `String` - Name of category
#### Example
> POST https://cybeat-api.herokuapp.com/category
>
Headers: "Accept: application/json"

Body:
```json
{
"name": "Alcohol"
}
```
#### Response
> Category with specified id as below
```json
{
"id": 16,
"name": "Alcohol"
}
```
> Message about operation as below
```text
An error occurred, try later
```
***

### API call
> PUT https://cybeat-api.herokuapp.com/category/{id}
>
Headers: "Accept: application/json"
#### Parameters
`id` required | type: `Integer` - Id of category
#### Body
`json object` which contains:

* `name` required | type: `String` - Name of category
#### Example
> PUT https://cybeat-api.herokuapp.com/category/1
>
Headers: "Accept: application/json"

Body:
```json
{
"name": "Pasta"
}
```
#### Response
> Message about operation from list below
```text
Category updated correctly
No "id" field in body of request
No category with id 1
```
***

### API call
> DELETE https://cybeat-api.herokuapp.com/category/{id}
>
Headers: "Accept: application/json"
#### Parameters
`id` required | type: `Integer` - Id of category
#### Example
> DELETE https://cybeat-api.herokuapp.com/category/1
>
Headers: "Accept: application/json"
#### Response
> Message about operation from list below
```text
Category removed correctly
No "id" field in body of request
No category with id 1
```
***

### API call
> DELETE https://cybeat-api.herokuapp.com/category
>
Headers: "Accept: application/json"
#### Response
> Message about operation from list below
```text
0 entries deleted
```
***

## Customer
### API call
> GET https://cybeat-api.herokuapp.com/customer
>
Headers: "Accept: application/json"
#### Response
> List of customers
```json
[
{
"id": 6,
"firstName": "Jane",
"lastName": "Smith",
"phone": "89500442211",
"registrationDate": "Oct 15, 2022, 1:40:51 PM"
},
{
"id": 4,
"firstName": "John",
"lastName": "Snow",
"phone": "89500442211",
"registrationDate": "Oct 10, 2022, 6:35:51 PM"
}
]
```
***

### API call
> GET https://cybeat-api.herokuapp.com/customer/{id}
>
Headers: "Accept: application/json"
#### Parameters
`id` required | type: `Integer`
#### Example
> GET https://cybeat-api.herokuapp.com/customer/1
>
Accept: application/json
#### Response
> Customer with specified id as below
```json
{
"id": 4,
"firstName": "John",
"lastName": "Snow",
"phone": "89500442211",
"registrationDate": "Oct 10, 2022, 6:35:51 PM"
}
```
> Or message about operation from list below
```text
No "id" field in body of request
No customer with id 1
```
***

### API call
> POST https://cybeat-api.herokuapp.com/customer
>
Headers: "Accept: application/json"
#### Body
`json object` which contains:

* `firstName` required | type: `String` - First name
* `lastName` required | type: `String` - Last name
* `phone` required | type: `String` - Phone
* `registrationDate` required | type: `String` - Date of registration
#### Example
> POST https://cybeat-api.herokuapp.com/customer
>
Headers: "Accept: application/json"

Body:
```json
{
"firstName": "Mike",
"lastName": "Ross",
"phone": "+89500332255",
"registrationDate": "Oct 15, 2022, 1:40:51 PM"
}
```
#### Response
> Customer with specified id as below
```json
{
"id": 7,
"firstName": "Mike",
"lastName": "Ross",
"phone": "+89500332255",
"registrationDate": "Oct 15, 2022, 1:40:51 PM"
}
```
> Message about operation as below
```text
An error occurred, try later
```
***

### API call
> PUT https://cybeat-api.herokuapp.com/customer/{id}
>
Headers: "Accept: application/json"
#### Parameters
`id` required | type: `Integer` - Id of customer
#### Body
`json object` which contains:

* `firstName` required | type: `String` - First name
* `lastName` required | type: `String` - Last name
* `phone` required | type: `String` - Phone
* `registrationDate` required | type: `String` - Date of registration
#### Example
> PUT https://cybeat-api.herokuapp.com/customer/1
>
Headers: "Accept: application/json"

Body:
```json
{
"firstName": "John",
"lastName": "Snow",
"phone": "89500442211",
"registrationDate": "Oct 10, 2022, 6:35:51 PM"
}
```
#### Response
> Message about operation from list below
```text
Customer updated correctly
No "id" field in body of request
No customer with id 1
```
***

### API call
> DELETE https://cybeat-api.herokuapp.com/customer
>
Headers: "Accept: application/json"
#### Response
> Message about operation from list below
```text
0 entries deleted
```
***

## Dish
### API call
> GET https://cybeat-api.herokuapp.com/dish
>
Headers: "Accept: application/json"
#### Response
> List of dishes
```json
[
{
"id": 7,
"item": "Test item",
"categoryId": 17,
"price": 1.00
},
{
"id": 8,
"item": "Burger",
"categoryId": 17,
"price": 19.90,
"weight": 50,
"calories": 67,
"description": ""
}
]
```
***

### API call
> GET https://cybeat-api.herokuapp.com/dish/{id}
>
Headers: "Accept: application/json"
#### Parameters
`id` required | type: `Integer`
#### Example
> GET https://cybeat-api.herokuapp.com/dish/8
>
Accept: application/json
#### Response
> Dish with specified id as below
```json
{
"id": 8,
"item": "Burger",
"categoryId": 17,
"price": 19.90,
"weight": 50,
"calories": 67,
"description": ""
}
```
> Or message about operation from list below
```text
No "id" field in body of request
No dish with id 1
```
***

### API call
> POST https://cybeat-api.herokuapp.com/dish
>
Headers: "Accept: application/json"
#### Body
`json object` which contains:

* `item` required | type: `String`
* `categoryId` required | type: `Integer` - foreign key to Categories.id
* `price` required | type: `BigDecimal/Float/Double`
* `weight` optional | type: `Integer nullable` - in grams
* `calories` optional | type: `Integer nullable` - in kcal
* `image` optional | type: `Integer nullable` - path
* `description` optional | type: `String nullable`
#### Example
> POST https://cybeat-api.herokuapp.com/dish
>
Headers: "Accept: application/json"

Body:
```json
{
"item": "Burger",
"categoryId": 17,
"price": 19.90,
"weight": 50,
"calories": 67,
"image": null,
"description": ""
}
```
#### Response
> Dish with specified id as below
```json
{
"id": 8,
"item": "Burger",
"categoryId": 17,
"price": 19.90,
"weight": 50,
"calories": 67,
"description": ""
}
```
> Message about operation as below
```text
An error occurred, try later
```
***

### API call
> PUT https://cybeat-api.herokuapp.com/dish/{id}
>
Headers: "Accept: application/json"
#### Parameters
`id` required | type: `Integer`
#### Body
`json object` which contains:

* `item` required | type: `String`
* `categoryId` required | type: `Integer` - foreign key to Categories.id
* `price` required | type: `BigDecimal/Float/Double`
* `weight` optional | type: `Integer nullable` - in grams
* `calories` optional | type: `Integer nullable` - in kcal
* `image` optional | type: `Integer nullable` - path
* `description` optional | type: `String nullable`
#### Example
> PUT https://cybeat-api.herokuapp.com/dish/7
>
Headers: "Accept: application/json"

Body:
```json
{
"id": 7,
"item": "Test item",
"categoryId": 17,
"price": 1.00
}
```
#### Response
> Message about operation from list below
```text
Dish updated correctly
No "id" field in body of request
No dish with id 7
```
***

### API call
> DELETE https://cybeat-api.herokuapp.com/dish/{id}
>
Headers: "Accept: application/json"
#### Parameters
`id` required | type: `Integer`
#### Example
> DELETE https://cybeat-api.herokuapp.com/dish/1
>
Headers: "Accept: application/json"
#### Response
> Message about operation from list below
```text
Dish removed correctly
No "id" field in body of request
No dish with id 1
```
***

### API call
> DELETE https://cybeat-api.herokuapp.com/dish
>
Headers: "Accept: application/json"
#### Response
> Message about operation from list below
```text
0 entries deleted
```
***

## Order
### API call
> GET https://cybeat-api.herokuapp.com/order
>
Headers: "Accept: application/json"
#### Response
> List of orders
```json
[
{
"id": 1,
"date": "Oct 17, 2022, 5:28:05 PM",
"dishesIds": [
7,
8
],
"dishesPrices": [
2,
1
],
"serverId": "aaaa-aaaaa-aaaa",
"orderId": 1
},
{
"id": 2,
"date": "Oct 17, 2022, 5:28:07 PM",
"dishesIds": [
7
],
"dishesPrices": [
3
],
"serverId": "aaaa-aaaaa-aaaa",
"orderId": 2
}
]
```
***

### API call
> GET https://cybeat-api.herokuapp.com/order/{id}
>
Headers: "Accept: application/json"
#### Parameters
`id` required | type: `Integer`
#### Example
> GET https://cybeat-api.herokuapp.com/order/1
>
Accept: application/json
#### Response
> Order with specified id as below
```json
{
"date": "Oct 17, 2022, 5:28:05 PM",
"dishesIds": [
7,
8
],
"dishesPrices": [
2,
1
],
"serverId": "aaaa-aaaaa-aaaa",
"orderId": 1
}
```
> Or message about operation from list below
```text
No "id" field in body of request
No order with id 1
```
***

### API call
> GET https://cybeat-api.herokuapp.com/order/{id}/price
>
Headers: "Accept: application/json"
#### Parameters
`id` required | type: `Integer`
#### Example
> GET https://cybeat-api.herokuapp.com/order/1/price
>
Accept: application/json
#### Response
> Order price
```text
21.90
```
> Or message about operation from list below
```text
No "id" field in body of request
No order with id 1
```
***

### API call
> POST https://cybeat-api.herokuapp.com/order
>
Headers: "Accept: application/json"
#### Body
`json object` which contains:

* `date` required | type: `LocalDateTime`
* `dishesIds` required | type: `List` - foreign key to Dishes.id
* `dishesPrices` required | type: `List`
* `serverId` required | type: `String`
* `orderId` required | type: `Integer `
#### Example
> POST https://cybeat-api.herokuapp.com/order
>
Headers: "Accept: application/json"

Body:
```json
{
"date": "Oct 17, 2022, 5:28:07 PM",
"dishesIds": [
7
],
"dishesPrices": [
3
],
"serverId": "aaaa-aaaaa-aaaa",
"orderId": 2
}
```
#### Response
> Dish with specified id as below
```json
{
"id": 2,
"date": "Oct 17, 2022, 5:28:07 PM",
"dishesIds": [
7
],
"dishesPrices": [
3
],
"serverId": "aaaa-aaaaa-aaaa",
"orderId": 2
}
```
> Message about operation as below
```text
An error occurred, try later
```
***

### API call
> PUT https://cybeat-api.herokuapp.com/order/{id}
>
Headers: "Accept: application/json"
#### Parameters
`id` required | type: `Integer`
#### Body
`json object` which contains:

* `date` required | type: `LocalDateTime`
* `dishesIds` required | type: `List` - foreign key to Dishes.id
* `dishesPrices` required | type: `List`
* `serverId` required | type: `String`
* `orderId` required | type: `Integer `
#### Example
> PUT https://cybeat-api.herokuapp.com/order/2
>
Headers: "Accept: application/json"

Body:
```json
{
"date": "Oct 17, 2022, 5:28:09 PM",
"dishesIds": [
8
],
"dishesPrices": [
4
],
"serverId": "aaaa-aaaaa-aaaa",
"orderId": 2
}
```
#### Response
> Message about operation from list below
```text
Order updated correctly
No "id" field in body of request
No order with id 2
```
***

### API call
> DELETE https://cybeat-api.herokuapp.com/order/{id}
>
Headers: "Accept: application/json"
#### Parameters
`id` required | type: `Integer`
#### Example
> DELETE https://cybeat-api.herokuapp.com/order/1
>
Headers: "Accept: application/json"
#### Response
> Message about operation from list below
```text
Order removed correctly
No "id" field in body of request
No order with id 1
```
***

### API call
> DELETE https://cybeat-api.herokuapp.com/order
>
Headers: "Accept: application/json"
#### Response
> Message about operation from list below
```text
0 entries deleted
```
***