Airport API

Aéroport-API

Le service Airport API, construit sur Django REST, est spécialement conçu pour surveiller les vols en provenance des aéroports du monde entier. Fournissant des détails complets sur les aéroports, les avions, les vols, les itinéraires et au-delà, cette API fonctionne comme un outil puissant pour gérer et analyser efficacement les données associées au voyage aérien.

Installation à l'aide de GitHub

Avant de commencer, assurez-vous que vous remplissez les conditions suivantes :

• Installez PostgresSQL et créez une base de données
• Python3 doit être déjà installé.

Exécutez le projet localement sans Docker

Installé

1. Clonez le dépôt :

git clone https://github.com/Sparix/Airport-API

2. Accédez au répertoire du projet :

 cd Airport_API

3. Créez un moteur Python virtuel et activez-le :

python -m venv venv 
source venv/bin/activate(on macOS)
venv S cripts a ctivate(on Windows)

4. Définissez les affectations du projet :

pip install -r requirements.txt

Variables d'environnement de configuration :

• Créez un fichier nommé .env, en utilisant .env.sample comme exemple.
• Assurez-vous d'avoir remplacé toutes les clés factices par vos données réelles.

 set SECRET_KEY= < secret_key >
set POSTGRES_HOST= < db_host_name >
set POSTGRES_DB= < db_name >
set POSTGRES_USER= < db_username >
set POSTGRES_PASSWORD= < password_db > 

Démarrage du serveur

1. Créez des migrations de bases de données :

python maange.py makemigrations
python manage.py migrate

2. Charger les données dans la base de données :

python manage.py loaddata data_base.json

3. Démarrez le serveur de développement :

python manage.py runserver

L'API devrait maintenant être accessible sur http://localhost:8000/

EXÉCUTER avec Docker

Docker devrait être installé

docker-compose build

docker-compose up

Obtenir l'accès

• créer un utilisateur api/user/register/

• obtenir le jeton d'accès api/user/token/

• Pour vous authentifier, incluez le jeton obtenu dans vos en-têtes de requête au format :

 - Authorization: Bearer < your-token > 

Documentation API

• L'API est documentée à l'aide du standard OpenAPI.
• Accédez à la documentation de l'API en exécutant le serveur et en accédant à http://localhost:8000/api/doc/swagger/ ou http://localhost:8000/api/doc/redoc/.

Caractéristiques du projet :

• Restriction des informations : la communication entre les administrateurs et les utilisateurs réguliers est limitée, garantissant que les utilisateurs accèdent uniquement aux informations autorisées.

• Détails de l'aéroport : récupérez des données complètes sur les aéroports mondiaux, y compris les noms, les codes d'aéroport et la proximité des principales villes et pays.

• Route Insights : accédez aux détails des différents itinéraires, englobant les noms des aéroports de départ et de destination ainsi que la distance qui les sépare.

• Détails de l'avion : récupérez des informations sur l'avion, telles que leurs noms, types, nombre de rangées de passagers et numéros de sièges par rangée. Le système comprend une fonction intégrée pour télécharger et stocker des images d'avion.

• Aperçu du vol : obtenez des informations détaillées sur le vol, notamment les détails de l'itinéraire, les heures de départ et d'arrivée, les détails de l'avion et la disponibilité des sièges. Filtrez la liste des vols par dates de départ et d'arrivée pour plus de commodité.

• Statut de la commande : les utilisateurs authentifiés peuvent consulter les informations de leur commande.

• Détails du billet : facilite l'ajout de billets d'avion, permettant aux utilisateurs de spécifier les numéros de rangée et de siège pour la commande.

• Mécanisme d'authentification : les utilisateurs peuvent créer des profils en fournissant une adresse e-mail et un mot de passe. L'API utilise l'authentification JWT (JSON Web Tokens) pour protéger les données de vol sensibles.