README.md

Avalon application

How to use the RESTful API ?

• Launch the script start_app.sh (you have to install docker-compose before it).
• Then you can send request as follows.
  • Initialize databases (3 tables)

       - method: PUT
       - route: /retart_db
       - payload example: {
                              "table1": "rules",
                              "table2": "games",
                              "table3": "players"
                          }
       - response example: {
                               "request": "succeeded"
                           }

  • Visualize databases (3 tables)

       - method: GET
       - route: /view/<table_name> (table_name is rules, games and players)
       - payload example:
       - response example: {
                               "rules": [
                                   {
                                       "blue": 3,
                                       "echec1": 1,
                                       "echec2": 1,
                                       "echec3": 1,
                                       "echec4": 1,
                                       "echec5": 1,
                                       "id": "5fb71032-7dad-4e48-bb14-7f4fb7c262fa",
                                       "nb_player": 5,
                                       "quest1": 2,
                                       "quest2": 3,
                                       "quest3": 2,
                                       "quest4": 3,
                                       "quest5": 3,
                                       "red": 2
                                   },
                                   {
                                       ...
                                   },
                                   {
                                       "blue": 6,
                                       "echec1": 1,
                                       "echec2": 1,
                                       "echec3": 1,
                                       "echec4": 2,
                                       "echec5": 1,
                                       "id": "f9bffa54-dc75-45f2-b2f8-51ad0c4f397f",
                                       "nb_player": 10,
                                       "quest1": 3,
                                       "quest2": 4,
                                       "quest3": 4,
                                       "quest4": 5,
                                       "quest5": 5,
                                       "red": 4
                                   }
                               ]
                           }

  • Start a new game

       - method: PUT
       - route: /games
       - payload example: {
                              "names": [
                                  "name1",
                                  "name2",
                                  "name3",
                                  "name4",
                                  "name5"
                              ],
                              "roles": [
                                  "oberon",
                                  "perceval",
                                  "morgan"
                              ]
                          }
       - response example: {
                               "id": "2669a9fe-37c4-4139-ab78-8e3f0d0607d0",
                               "players": [
                                   {
                                       "id": "95763b27-de50-4d39-8ac2-2a7010281788",
                                       "name": "name1",
                                       "role": "assassin",
                                       "team": "red"
                                   },
                                   {
                                       ...
                                   },
                                   {
                                       "id": "83d21d25-f359-4ddc-9048-69ba1e6cf5b5",
                                       "name": "name5",
                                       "role": "morgan",
                                       "team": "red"
                                   }
                               ]
                           }

  • Get mp3 file

       - method: GET
       - route: /<game_id>/mp3
       - payload example:
       - response example: response.mpga

  • Visualize game

       - method: GET
       - route: /games/<game_id>
       - payload example:
       - response example: {
                               "current_id_player": "79d33eb2-199c-40a2-8205-27cc3511aede",
                               "current_quest": 1,
                               "nb_echec_to_fail": {
                                   "echec1": 1,
                                   "echec2": 1,
                                   "echec3": 1,
                                   "echec4": 1,
                                   "echec5": 1
                               },
                               "nb_mission_unsend": 0,
                               "nb_player_to_send": {
                                   "quest1": 2,
                                   "quest2": 3,
                                   "quest3": 2,
                                   "quest4": 3,
                                   "quest5": 3
                               }
                           }

  • Send new mission

       - method: POST
       - route: /<game_id>/mission
       - payload example1: {
                               "status": "unsend"
                           }
       - response example1: {
                                "request": "succeeded"
                            }
       - payload example2: {
                               "status": "send"
                           }
       - response example2: {
                                "players": [
                                    {
                                        "id": "147ff90f-9988-45f3-bf39-c98d9fc48e3a",
                                        "name": "name1"
                                    },
                                    {
                                        ...
                                    },
                                    {
                                        "id": "d8cc0522-5389-4d15-9f2c-9c377b6260df",
                                        "name": "name5"
                                    }
                                ]
                            }

  • Send new vote

       - method: POST
       - route: /<game_id>/vote
       - payload example1: {
                               "vote": ["SUCCESS", "FAIL"]
                           }
       - response example1: {
                                "result": "FAIL",
                                "vote": [
                                    "FAIL",
                                    "SUCCESS"
                                ]
                            }
       - payload example2: {
                               "vote": ["SUCCESS", "SUCCESS"]
                           }
       - response example2: {
                                "result": "SUCCESS",
                                "vote": [
                                    "SUCCESS",
                                    "SUCCESS"
                                ]
                            }