|
@@ -3,17 +3,28 @@
|
|
## Back End
|
|
## Back End
|
|
|
|
|
|
```
|
|
```
|
|
-Pages/Form Endpoints
|
|
|
|
-GET / -> Page with 3 forms for set name, new game, and join game
|
|
|
|
-POST /name -> Receive name (and secret?) from form
|
|
|
|
-POST /newGame -> Receive time limit from form
|
|
|
|
-POST /joinGame -> Receive ID from form
|
|
|
|
-GET /summary/{ID} -> Return page summarizing game
|
|
|
|
-GET /play/{ID} -> returns Front End w/ ID and name set
|
|
|
|
-
|
|
|
|
API Endpoints
|
|
API Endpoints
|
|
|
|
+GET /
|
|
|
|
+ Returns {
|
|
|
|
+ "version": string
|
|
|
|
+ }
|
|
|
|
+POST /name
|
|
|
|
+ Accepts {
|
|
|
|
+ "name": string,
|
|
|
|
+ "secret": string
|
|
|
|
+ }
|
|
|
|
+ Returns 400 vs 204, sets session cookie
|
|
|
|
+PUT /game
|
|
|
|
+ Requires session cookie
|
|
|
|
+ Accepts {
|
|
|
|
+ "timer": number
|
|
|
|
+ }
|
|
|
|
+ Returns {
|
|
|
|
+ "gameId": string
|
|
|
|
+ }
|
|
GET /game/{ID}
|
|
GET /game/{ID}
|
|
- {
|
|
|
|
|
|
+ Requires session cookie
|
|
|
|
+ Returns {
|
|
"timer": number,
|
|
"timer": number,
|
|
"coords": {
|
|
"coords": {
|
|
"1": {
|
|
"1": {
|
|
@@ -23,7 +34,8 @@ GET /game/{ID}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
GET /game/{ID}/guesses/{name}
|
|
GET /game/{ID}/guesses/{name}
|
|
- {
|
|
|
|
|
|
+ Requires session cookie
|
|
|
|
+ Returns {
|
|
"currentRound": string || null,
|
|
"currentRound": string || null,
|
|
"guesses": {
|
|
"guesses": {
|
|
"1": {
|
|
"1": {
|
|
@@ -34,11 +46,12 @@ GET /game/{ID}/guesses/{name}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
POST /game/{ID}/guesses/{name}/{round}
|
|
POST /game/{ID}/guesses/{name}/{round}
|
|
|
|
+ Requires session cookie
|
|
Accepts {
|
|
Accepts {
|
|
"lat": number,
|
|
"lat": number,
|
|
"lon": number,
|
|
"lon": number,
|
|
}
|
|
}
|
|
- 400 vs 201
|
|
|
|
|
|
+ Returns 400 vs 201
|
|
```
|
|
```
|
|
|
|
|
|
## Front End
|
|
## Front End
|