Skip to content

Xylo87/SfAPI_Users

Repository files navigation

⚡➡️ Consommation d'API REST avec Symfony + Création d'une API depuis des entités SF

1. Description

Ce projet est un exercice pratique de programmation web utilisant le framework PHP Symfony et le composant HTTPClient. Il permet d'afficher des informations relatives à une serie aléatoire d'utilisateurs fictifs, récupérée via à l'API publique randomuser.me. Un bouton pour chaque carte utilisateur permet d'enregistrer ces informations au sein d'un base de données MySQL. Les données sont ensuite exposées via les paramètres des entités Doctrine et le mini-framework API Platform, et peuvent être récupérées au format JSON via JavaScript.


2. Fonctionnalités

  • Affichage d'informations relatives à une serie aléatoire d'utilisateurs fictifs sous forme de cartes (mise en forme CSS)

  • Bouton d'ajout pour l'enregistrement en base de données des informations pour chaque utilisateur


3. Installation

  1. Clonez ce projet depuis GitHub :

    bash
    git clone https://github.com/Xylo87/SfAPI_Users.git
    cd SfAPI_Users
    
  2. Assurez-vous que PHP est installé sur votre machine en exécutant la commande suivante :

    bash
    php --version
    

    Veiller à utiliser une version 8.2 minimum de PHP, sinon procéder à son téléchargement via ce lien

  3. Installer un logiciel type "Laragon" pour disposer d'un environnement qui permet d'exécuter un script PHP :

  • Télécharger Laragon ici
  • Démarrer Laragon
  • Enregistrer le "Repo" dans le dossier laragon\www\
  • Si le téléchargement d'une nouvelle version de PHP a été nécessaire, veillez suivre les instructions suivantes pour lier PHP et Apache à Laragon : PHP / Apache
  1. Il faudra installer (dans l'ordre) : -- composer -- scoop avec le Powershell Windows -- Symfony CLI

  2. Démarrer le serveur de Symfony en tâche de fond :

bash
symphony serve -d
  1. Exécuter la commande suivante pour installer les dépendances nécessaires :
bash
composer install
  1. Exécuter le fichier sfapi_users au sein d'un environnement MySQL (via HeidiSQL embarqué avec Laragon par exemple)

  2. Pour commencer la navigation, veuillez exécuter la requêtre suivante dans la barre d'URL :

https://127.0.0.1:8000/users

8(+). La route /api permet de visualiser, via l'interface API Platform, les endpoints des entités/propriétés exposées


4. Auteur

Ce projet a été réalisé par Théo Arbogast (aka Xylo87).
N'hésitez pas à ouvrir une issue ou à me contacter pour toute suggestion ou question.

About

⚡➡️ Consommation d'API REST avec Symfony + Création d'une API depuis des entités SF

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published