Skip to content

Commit

Permalink
Add method info
Browse files Browse the repository at this point in the history
  • Loading branch information
mnpw committed Jul 1, 2022
1 parent 06af410 commit eb5f510
Showing 1 changed file with 12 additions and 1 deletion.
13 changes: 12 additions & 1 deletion zzva-web/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,4 +6,15 @@
Web layer of zzva. This includes various endpoints exposed via `actix-web` that allow you to interact with the game.

## Quick Start
Use `cargo r` to run the server. Uses port `8080`.
Use `cargo r` to run the server. Uses port `8080`.

## Methods
### get
- `/health_check`
- `/view` -> Get prettified view of game board
- `/view_raw` -> -> Get raw view of game board
- `/status` -> Get status: Won, Lost, InProgress
### post
- `/start` : `"board=<board>&max=<max>"` -> Start game with chosen board size and winning tile
- `/start_default` -> Start game with default settings
- `/play` : `"direction=<direction>"` -> Play move in a direction

0 comments on commit eb5f510

Please sign in to comment.