scouts-server

README

scouts-server

Backend Go implementation of Aaron's Scouts game.

Package Documentation

Refer to package scouts for documentation.

API Documentation

User API

The server publicly exposes these endpoints:

• GET /api/v1/users/{id}: get a user by ID
• POST /api/v1/users: create a new user
• POST /api/v1/login: log in as a user

Games API

The server publicly exposes these endpoints:

• GET /api/v1/game: list all games
• GET /api/v1/game/{id}: get a game by ID
• GET /api/v1/game/{id}/events: subscribe to events for a game using Server-Sent Events
• POST /api/v1/game: create a new game
• POST /api/v1/game/{id}/join: join a game
• POST /api/v1/game/{id}/move: make a move in a game

All the above endpoints require the following headers:

• Content-Type: application/json
• Authorization: the session token, either with type Bearer or Bot.