Commit 875c7d29 authored by Zohten's avatar Zohten

updated doc

parent 4921533a
...@@ -35,6 +35,10 @@ C.f la documentation [Installation](doc/Installation.md). ...@@ -35,6 +35,10 @@ C.f la documentation [Installation](doc/Installation.md).
Pour des raisons de non résolution de chemins par VueJS, on est obligé de passer par 2 serveurs web. Il faut donc lancer XAMP et faire un `npm run serve` dans le fichier frontend. Pour des raisons de non résolution de chemins par VueJS, on est obligé de passer par 2 serveurs web. Il faut donc lancer XAMP et faire un `npm run serve` dans le fichier frontend.
## Documentation de l'API
Une documentation détaillée de l'API est disponible [ici](doc/BackSummary.md).
## Fonctionnalitées ## Fonctionnalitées
### Ce qui fonctionne frontend+backend ### Ce qui fonctionne frontend+backend
...@@ -49,7 +53,7 @@ Pour des raisons de non résolution de chemins par VueJS, on est obligé de pass ...@@ -49,7 +53,7 @@ Pour des raisons de non résolution de chemins par VueJS, on est obligé de pass
- Partybeta (affichage de la main, discard, draw, check kong et pung) - Partybeta (affichage de la main, discard, draw, check kong et pung)
### Ce qui fonctionne backend ### Ce qui fonctionne backend uniquement
- Ouverture de partie publique ou privée - Ouverture de partie publique ou privée
- Modification de profil (par l'utilisateur authentifié ou par un admin) - Modification de profil (par l'utilisateur authentifié ou par un admin)
......
# Résumé des points d'accès de l'API
Pour tester les différents endpoint, nous avons centralisé les requêtes dans des fichiers `.http` dans `BackEnd/src/testRequests`. Nous vous invitons à y jeter un coup d'oeil. On utilisait l'extension REST IO de VSCode avec ces fichiers.
|Endpoint principal |Description|
|------------------------------|-----------|
|[`/login`]()|Concerne l'authentification|
|[`/user`]()|Concerne l'utilisateur|
|[`/blacklist`]()|Concerne la blacklist|
|[`/game`]()|Concerne les salles de jeu|
|[`/round`]()|Concerne les rounds de jeu|
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment