Skip to content

Documentation technique

Jump to bottom
HiroKX edited this page Jan 19, 2024 · 29 revisions

Dépendances et packages

API REST

Nous avons fait le choix d'utiliser Swagger afin de fournir à l'utilisateur une interface web affichant et décrivant notre API.

Celle-ci est dite "RESTFUL" puisque les méthodes suivent la norme RFC2616 GET permettent d'obtenir, POST de créer, PUT de modifier et DELETE de supprimer.

Afin de pouvoir comprendre comment l'api fonctionne, voici le descriptif de chaque route. Egalement disponible sur

Routes HTTP

Sondage

  • GET /api/sondage/{id} - Obtenez un sondage
  • PUT /api/sondage/{id} - Mettez à jour un sondage
  • DELETE /api/sondage/{id} - Supprimez un sondage
  • GET /api/sondage/ - Obtenez tous les sondages
  • POST /api/sondage/ - Créez un nouveau sondage

Participant

  • GET /api/participant/{id} - Obtenez un participant
  • GET /api/participant/ - Obtenez tous les participants
  • POST /api/participant/ - Créez un nouveau participant
  • PUT /api/participant/{id} - Mettez à jour un participant
  • DELETE /api/participant/{id} - Supprimez un participant

Commentaire

  • PUT /api/commentaire/{id} - Mettez à jour un commentaire
  • DELETE /api/commentaire/{id} - Supprimez un commentaire
  • GET /api/sondage/{id}/commentaires - Obtenez les commentaires d'un sondage
  • POST /api/sondage/{id}/commentaires - Créez un commentaire pour un sondage

Dates

  • GET /api/sondage/{id}/dates - Obtenez les dates d'un sondage
  • POST /api/sondage/{id}/dates - Créez une date pour un sondage
  • GET /api/sondage/{id}/maybe - Obtenez les meilleures dates pour un sondage
  • GET /api/sondage/{id}/best - Obtenez les meilleures dates pour un sondage
  • DELETE /api/date/{id} - Supprimez une date

Participation

  • POST /api/date/{id}/participer - Participez à une date

Pipeline

  • Jacoco Code Coverage:
  • Pitest:
  • Java CI with Maven:
  • Tests E2E:
  • Checkstyle:
  • pages-build-deployment:

Packages maven / import Java spcifiques :

Clone this wiki locally