diff --git a/api.md b/api.md new file mode 100644 index 0000000..07e4c47 --- /dev/null +++ b/api.md @@ -0,0 +1,48 @@ +# 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" +} +``` \ No newline at end of file