Airport API

Flughafen-API

Der auf Django REST basierende Airport-API-Dienst ist speziell für die Überwachung von Flügen von Flughäfen auf der ganzen Welt konzipiert. Diese API stellt umfassende Details zu Flughäfen, Flugzeugen, Flügen, Routen und darüber hinaus bereit und fungiert als leistungsstarkes Tool zur effektiven Verwaltung und Analyse von Daten im Zusammenhang mit Flugreisen.

Installation mit GitHub

Bevor Sie beginnen, stellen Sie sicher, dass Sie die folgenden Anforderungen erfüllt haben:

• Installieren Sie PostgresSQL und erstellen Sie eine Datenbank
• Python3 muss bereits installiert sein.

Führen Sie das Projekt lokal ohne Docker aus

Installiert

1. Klonen Sie das Repository:

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

2. Gehen Sie in das Projektverzeichnis:

 cd Airport_API

3. Erstellen Sie eine virtuelle Python-Engine und aktivieren Sie sie:

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

4. Legen Sie die Projektzuweisungen fest:

pip install -r requirements.txt

Konfigurationsumgebungsvariablen:

• Erstellen Sie eine Datei mit dem Namen .env und verwenden Sie dabei .env.sample als Beispiel.
• Stellen Sie sicher, dass Sie alle Dummy-Schlüssel durch Ihre tatsächlichen Daten ersetzt haben.

 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 > 

Starten des Servers

1. Erstellen Sie Datenbankmigrationen:

python maange.py makemigrations
python manage.py migrate

2. Daten in die Datenbank laden:

python manage.py loaddata data_base.json

3. Starten Sie den Entwicklungsserver:

python manage.py runserver

Die API sollte nun unter http://localhost:8000/ zugänglich sein.

RUN mit Docker

Docker sollte installiert sein

docker-compose build

docker-compose up

Zugriff erhalten

• Benutzer-API/user/register/ erstellen

• Zugriffstoken api/user/token/ abrufen

• Fügen Sie zur Authentifizierung das erhaltene Token in Ihre Anforderungsheader im folgenden Format ein:

 - Authorization: Bearer < your-token > 

API-Dokumentation

• Die API ist mithilfe des OpenAPI-Standards dokumentiert.
• Greifen Sie auf die API-Dokumentation zu, indem Sie den Server ausführen und zu http://localhost:8000/api/doc/swagger/ oder http://localhost:8000/api/doc/redoc/ navigieren.

Merkmale des Projekts:

• Informationsbeschränkung : Die Kommunikation zwischen Administratoren und regulären Benutzern ist begrenzt, um sicherzustellen, dass Benutzer nur auf berechtigte Informationen zugreifen.

• Flughafendetails : Rufen Sie umfassende Daten zu Flughäfen weltweit ab, einschließlich Namen, Flughafencodes und Nähe zu Großstädten und Ländern.

• Routeneinblicke : Greifen Sie auf Details zu verschiedenen Routen zu, einschließlich der Namen von Abflug- und Zielflughäfen sowie der Entfernung zwischen ihnen.

• Flugzeugdetails : Rufen Sie Informationen über Flugzeuge ab, z. B. deren Namen, Typen, Anzahl der Passagierreihen und Sitzplatznummern pro Reihe. Das System verfügt über eine integrierte Funktion zum Herunterladen und Speichern von Flugzeugbildern.

• Flugübersicht : Erhalten Sie detaillierte Fluginformationen, einschließlich Routendetails, Abflug- und Ankunftszeiten, Flugzeugdetails und Sitzplatzverfügbarkeit. Filtern Sie die Flugliste für zusätzlichen Komfort nach Abflug- und Ankunftsdatum.

• Bestellstatus : Authentifizierte Benutzer können ihre Bestellinformationen überprüfen.

• Ticketdetails : Erleichtert das Hinzufügen von Flugtickets und ermöglicht Benutzern die Angabe von Reihen- und Sitzplatznummern für die Bestellung.

• Authentifizierungsmechanismus : Benutzer können Profile erstellen, indem sie eine E-Mail-Adresse und ein Passwort angeben. Die API nutzt die JWT-Authentifizierung (JSON Web Tokens), um sensible Flugdaten zu schützen.