Card game API (WIP)

This is a RESTful API for a very fun card game created in Java. Disclaimer: this work is currently in progress.

Setup

Maven is used to build this project. This was develop and built using VS Code on Windows.

Dependencies

This project uses Spring framework to provide the REST operations. Also it uses GemFire to persist the data to a in-memory database.

Philosophy

The code concerns are separated in domains (e.g. game, players, etc) then into multiple layers. The API is fronted by a controller so that the business logic can be decoupled and re-use for an other interface. The business logic is wrapped in a Service class and depends upon an interface of a repository to persist the data.

Use cases and class diagrams are available here.

API Usage

Create a game

curl --request POST \
  --url http://localhost:8080/game

Delete a game

curl --request DELETE \
  --url http://localhost:8080/game/{gameId}

Add a game deck to a game

curl --request POST \
  --url http://localhost:8080/game/{gameId}/deck

Add a player to a game

curl --request POST \
  --url http://localhost:8080/game/{gameId}/player \
  --header 'content-type: application/x-www-form-urlencoded' \
  --data 'name={playerName}'

Remove a player from a game

curl --request DELETE \
  --url http://localhost:8080/game/{gameId}/player \
  --header 'content-type: application/x-www-form-urlencoded' \
  --data 'name={playerName}'

Get the list of players in a game

curl --request GET \
  --url http://localhost:8080/game/{gameId}/player