Boursière
Getting started
Run the tests.
go test
Start the server in development mode.
go run .
Routes
See the detailed route description for more information.
| Method | Path | Description |
|---|---|---|
| GET | /api/beers | Get the current status of all beers. |
| GET | /api/beers/events | SSE route to get notified of price and quantity updates. |
| POST | /api/beers/order | Add (or remove) an amount to beers' sold quantities. Authentication is required. |
| GET | /api/beers/stats | Get current statistics about the event (only estimated profit for now). Authentication as admin is required. |
| GET | /api/users | Get the list of all existing users. Authentication as admin is required. |
| POST | /api/users | Create a new user. Authentication as admin is required. |
| PATCH | /api/users/:id | Update a user. Authentication is required. |
| DELETE | /api/users/:id | Delete a user. Authentication as admin is required. |
| POST | /api/users/token | Generate a new access token in exchange for name/password authentication. |
| DELETE | /api/users/token | Delete a given access token, effectively logging out. |
Database
The beers table contains all static information about a beer type. On the other hand, history contains dynamic information such as the current price and quantity. For instance, a beer current selling price can simply be found by looking at its most recent history entry.
The users and tokens tables are used to authenticate accesses to the API.
