R09. Rest API - PastoriLucas/Dev.Web GitHub Wiki

Documentation de l'API

URL de base

L'URL de base sert de 'point de départ' pour chaque requête qui sera effectuée à l'API. Dans le cas d'une erreur 404 NOT FOUND, c'est dans cet URL qu'il faut vérifier en premier s'il n'y a pas d'erreurs. Dans notre cas, l'URL de base est : http://51.178.40.75:8888/api/ L'API renvoie toutes les réponses sous format JSON. Ce format est très facile à générer et à analyser, ce qui implique une utilisation facile de celui-ci. La documentation ci-dessous rassemble toutes les requêtes qui peuvent être réalisées au travers de cette API

Différentes requêtes

Paramètres

  • Username
  • Password

Permet de se connecter au compte pour lequel les identifiants ont été rentrées. (à l'aide de cookies)

Permet de se déconnecter du compte actuellement connecté (à l'aide de cookies)

Récupère la liste des événements dans la base de données.

Récupère la liste des événements sélectionnées et triés en fonction du paramètre de tri donné. (Date de début, date de fin, année ou nom).

Récupère la liste des événements sélectionnées et triés en fonction de l'année de déroulement de celui-ci.

Récupère la liste de photos a afficher dans la galerie en fonction du paramètre de style.

Paramètres

  • Firstname
  • Lastname
  • Email
  • Password

Permet de créer un nouvel utilisateur dans la base de données. Attention, les 4 paramètres ne peuvent pas être n'importe lesquels. 'firstname' et 'lastname' sont obligatoires et ne doivent posséder que des caractères alphanumériques. 'email' doit avoir se présenter sous la forme '[email protected]'. Pour finir, 'password' doit avoir entre 8 et 50 caractères, doit avoir au moins une majuscule et une minuscule et doit posséder au minimum un chiffre et un caractère spécial.

Paramètres

  • User_Id
  • Likes
  • Oeuvre

Permet d'incrémenter le compteur de like d'une photo.

Paramètres

  • User_Id
  • Likes
  • Oeuvre

Permet de décrémenter le compteur de like d'une photo.

Paramètres

  • Fichier image
  • Nom
  • Taille
  • Catégorie

Permet au compte administrateur de rajouter une image dans la base de données.

Paramètres

  • Fichier image
  • Nom
  • Date de début
  • Date de fin
  • Lieu
  • Description

Permet au compte admin de rajouter des événements dans la base de données.

Paramètres

  • Nom d'utilisateur
  • Commentaire
  • Oeuvre

Permet de rajouter un commentaire sous une photo.

Permet de récupérer les commentaire d'une photo ayant l'id "id".

Paramètres

  • Nom d'utilisateur
  • Commentaire
  • Evénement

Permet de rajouter un commentaire sous un événement.

Permet de récupérer les commentaire d'un événement ayant l'id "id".

Paramètres

  • Password

Permet à l'administrateur de se connecter à son compte permettant de modifier les ressources du site.

⚠️ **GitHub.com Fallback** ⚠️