postnummer-app/api.md
2023-02-10 08:45:40 +01:00

48 lines
423 B
Markdown

# Api specification
## Review
### Review model
```ts
{
id: number,
location: string,
title: string,
content: string,
stars: number
}
```
### GET reviews
#### Response
```ts
{
Review[]
}
```
### Post createReview
#### Request
```ts
{
location: string,
title: string,
content: string,
stars: number
}
```
#### Response
```ts
{
message: "Ok" | "Invalid request"
}
```