laravel api

Projet back-end Laravel/PHP

Lien vers la version de production en direct

Bienvenue dans un autre de mes projets API. Pour ce projet, j'ai écrit, testé et déployé une application Laravel dans le cadre d'un projet full-stack, profitant de nombreuses fonctionnalités puissantes du framework, notamment :

• façades et fonctions auxiliaires ;
• authentification et autorisation des utilisateurs ;
• amorçage de bases de données ;
• Générateur de requêtes ORM éloquent ;
• outils de test API avancés.

A quoi ça sert ?

Cette API traite les données relatives aux utilisateurs/candidats et à leurs examens. Par exemple, il permet à un utilisateur d'afficher des informations sur les lieux/lieux d'examen, les dates, les noms des candidats, etc.

Une remarque importante sur l'accès

• Assurez-vous d'inclure un en-tête HTTP Accept: application/json avec toutes les requêtes adressées à l'API.
• La plupart des fonctionnalités de l'API ne sont disponibles que pour les utilisateurs de niveau administrateur. Pour expérimenter cette application, vous pouvez créer un nouveau compte en utilisant un e-mail se terminant par @v3.admin, ce qui vous donnera tous les privilèges d'administrateur.

 // To sign up as an admin, make a POST request to https://laravel-php-api.vercel.app/public/api/signup and include a request body in the following format:

        {
		    "name" : " Anna Torpid " ,
		    "email" : " [email protected] " ,
		    "password" : " dfbdf9suhfd9shf " ,
		    "password_confirmation" : " dfbdf9suhfd9shf "
        }

// To login, make a POST request to https://laravel-php-api.vercel.app/public/api/login and include a request body in the following format:

        {
		    "email" : " [email protected] " ,
		    "password" : " dfbdf9suhfd9shf "
        }

// The above POST request returns this response. Make sure to include the returned token in the authorisation header of all future requests.

        {
	        "user" : {
		        "id" : 11 ,
		        "name" : " Anna Torpid " ,
		        "email" : " [email protected] "
	        },
	        "token" : " 5|tAujbY9luWTKquNEruGHU7soCXp7MuzVb8WR0VO9 "
        }

Une fois inscrit ou connecté, vous recevrez un jeton API qui devra être joint aux en-têtes de votre demande afin de garantir un accès CRUD complet.

Points de terminaison disponibles

Pour accéder à chaque extrémité, ajoutez le fragment URI à l'endoint racine. Vous pouvez afficher plus de détails en visitant le point de terminaison racine.

Ressource	Description	Authentification/autorisation
POST/inscription	Créez un nouveau compte.	Publique
POST / connexion	Connectez-vous au compte existant.	Publique
OBTENIR /déconnexion/{id}	Se déconnecter (révoque les jetons).	Utilisateurs connectés uniquement
OBTENIR/examens	Affiche la liste de tous les examens. Comprend 5 paramètres de requête facultatifs .	Administrateur uniquement
OBTENIR /examens/{id}	Obtenez un examen spécifique.	Ne peut voir que ses propres examens
METTRE /examens/{id}	Modifier un examen spécifique.	Ne peut modifier que ses propres examens
OBTENIR /examens/recherche/{nom}	Recherche de sous-chaîne pour un candidat spécifique.	Administrateur uniquement
SUPPRIMER /examens/{id}	Supprimer l'examen.	Ne peut supprimer que son propre examen
OBTENIR /utilisateurs	Obtenez la liste de tous les utilisateurs.	Administrateur uniquement
OBTENIR /users/{id}/exams	Obtenir la liste de tous les examens pour un utilisateur	Ne peut voir que ses propres examens

Principales caractéristiques du produit

• Déployé sur Vercel en tant que « fonction sans serveur », utilisant un runtime PHP pour gérer la configuration des applications.
• Le déploiement en production est lié à une base de données PSQL en direct hébergée à distance chez un autre fournisseur.
• Syntaxe expressive spécifique à Laravel avec un chaînage de méthodes étendu, permettant une structure de code plus concise.
• Développé de manière pilotée par des tests en utilisant PHPUnit et la syntaxe JSON fluide de Laravel (basée sur les fermetures et la classe AssertableJson).
• Tests automatisés avec un workflow CI/CD configuré à l'aide de Github Actions.
• Architecturé à l'aide d'un modèle MVC orienté objet
• Services d'authentification implémentés à l'aide de Sanctum
  • Les utilisateurs peuvent s'inscrire et se connecter.
  • Les routes protégées ne sont accessibles qu'aux utilisateurs disposant de jetons API valides.
• Services d'autorisation mis en œuvre à l'aide des portes de Laravel, une approche d'autorisation basée sur la fermeture.
  • Certaines actions ne sont autorisées qu'aux utilisateurs ayant des rôles spécifiques, tels que le statut d'administrateur.
• Relations et contraintes de schéma définies à l'aide des outils de relations d'Eloquent ORM
• Base de données SQLite utilisée pour le développement et les tests.

Principaux fichiers et dossiers du répertoire du projet

• ./app contient la logique de base de l'application.
  • /app/Http/Controllers contient la logique de gestion des requêtes.
  • app/Models contient toutes les classes de modèles et c'est là que nous spécifions tous les champs à remplir.
  • app/Providers contient des classes qui amorcent l’ensemble de l’application.
• ./routes/api.php est l'endroit où nous définissons de manière concise toutes nos routes (points de terminaison).
• ./tests/Feature contient tous les tests d'intégration de l'application.
• ./config/database.php vous permet de configurer les paramètres de connexion à votre base de données.
• ./database est un autre dossier très important.
  • ./database/factories contient les classes d'usine qui sont utilisées pour amorcer les bases de données.
  • ./database/migrations nous permet de modifier notre modèle de données
  • ./databse/seeders contient des classes qui amorcent la base de données via des usines.

Exécuter le projet dans votre environnement local

Tout d’abord, assurez-vous que PHP et Composer sont installés sur votre ordinateur.

Version minimale requise : PHP ^8.1 ; Compositeur 2.5.4 .

1. Forkez et clonez le référentiel.

2. cd dans le référentiel et exécutez ces commandes CLI :

    composer update
    composer install
   

3. Renommez votre fichier .env.example en .env , supprimez les variables de la connexion mysql par défaut et assurez-vous d'ajouter les 3 variables suivantes :

    DB_CONNECTION=sqlite
    DB_FOREIGN_KEYS=true
    USE_SQLITE_SYNTAX=like
    DB_DATABASE= this needs to be the absolute path to the sqlite database located in ./database/database.sqlite, e.g. /home/username/mydocuments/laravel-api/database/database.sqlite*
   

4. Pour démarrer le serveur de développement local, exécutez la commande Artisan CLI :

    php artisan serve
   

5. Pour exécuter la combinaison de test, exécutez la commande Artisan CLI :

    php artisan test