Nous créons une API qui permet de renvoyer les lieux touristiques (musées, restaurants, hôtels...) pour une ville donnée et les villes touristiques pour un pays donné.
Cloner le repository dans le dossier de son choix :
git clone https://github.com/evanhzg/voyagevoyage.gitInstaller les dépendances :
cd 'Mon dossier'/voyagevoyage
composer installCréer une paire clé privée/publique :
openssl genrsa -out config/jwt/private.pem -aes256 4096
openssl rsa -pubout -in config/jwt/private.pem -out config/jwt/public.pemCréez une copie du fichier .env nommée .env.local et remplissez la ligne 27 pour assurer la connection avec votre basse de donnée ainsi que la ligne 34 avec la passphrase qui vous a permis de générer votre clé privée.
N'oubliez pas de créer la base de donnée :
php bin/console d:d:cMettre à jour le schéma de base de données :
php bin/console d:s:u --forceEt alimenter la base de données :
php bin/console d:f:lN'oubliez pas de lancer votre Apache et MySQL, et de faire la commande :
symfony serveC'est prêt !
Un dossier contenant des requêtes pratiques est accessible en important le lien postman :
https://www.getpostman.com/collections/2fd0d55f5c8e4481b84e
Pour commencer à utiliser l'api il faut d'abord se connecter
La requête de connexion est dans le dossier Postman. Les credentials sont :
{
"username": "admin",
"password": "admin"
}
Récupérez le token donné, et renseignez-le en tant que Bearer Token pour toutes les prochaines requêtes sur l'API.
L'API manipule 3 types de ressources : Country, City et Place. Chacune de ses ressources est accessibles via 'ip du serveur'/api/countries, 'ip du serveur'/api/cities, 'ip du serveur'/api/places.
La documentation est disponible via deux endpoints :
- /api/doc pour la version navigateur
- /api/doc.json pour la version json