Airport API

Aeropuerto-API

El servicio Airport API, creado sobre Django REST, está diseñado específicamente para monitorear vuelos que se originan en aeropuertos de todo el mundo. Al proporcionar detalles completos sobre aeropuertos, aviones, vuelos, rutas y más, esta API funciona como una herramienta poderosa para administrar y analizar de manera efectiva los datos asociados con los viajes aéreos.

Instalación usando GitHub

Antes de comenzar, asegúrese de haber cumplido con los siguientes requisitos:

• Instalar PostgresSQL y crear base de datos.
• Python3 ya debe estar instalado.

Ejecute el proyecto localmente sin Docker

Instalado

1. Clonar el repositorio:

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

2. Vaya al directorio del proyecto:

 cd Airport_API

3. Cree un motor Python virtual y actívelo:

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

4. Establecer las asignaciones del proyecto:

pip install -r requirements.txt

Variables de entorno de configuración:

• Cree un archivo llamado .env, usando .env.sample como ejemplo.
• Asegúrese de haber reemplazado todas las claves ficticias con sus datos reales.

 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 > 

Iniciando el servidor

1. Crear migraciones de bases de datos:

python maange.py makemigrations
python manage.py migrate

2. Cargar datos a la base de datos:

python manage.py loaddata data_base.json

3. Inicie el servidor de desarrollo:

python manage.py runserver

Ahora debería poder accederse a la API en http://localhost:8000/

EJECUTAR con Docker

Docker debería estar instalado

docker-compose build

docker-compose up

Obteniendo acceso

• crear usuario api/usuario/registro/

• obtener token de acceso api/usuario/token/

• Para autenticarse, incluya el token obtenido en los encabezados de su solicitud con el formato:

 - Authorization: Bearer < your-token > 

Documentación API

• La API está documentada utilizando el estándar OpenAPI.
• Acceda a la documentación de la API ejecutando el servidor y navegando a http://localhost:8000/api/doc/swagger/ o http://localhost:8000/api/doc/redoc/.

Características del proyecto:

• Restricción de información : la comunicación entre administradores y usuarios habituales es limitada, lo que garantiza que los usuarios accedan únicamente a la información autorizada.

• Detalles del aeropuerto : recupere datos completos sobre aeropuertos globales, incluidos nombres, códigos de aeropuerto y proximidad a las principales ciudades y países.

• Información sobre rutas : acceda a detalles sobre diferentes rutas, que incluyen los nombres de los aeropuertos de salida y destino junto con la distancia entre ellos.

• Detalles del avión : recupere información sobre el avión, como sus nombres, tipos, número de filas de pasajeros y número de asientos por fila. El sistema incluye una función incorporada para descargar y almacenar imágenes de aviones.

• Descripción general del vuelo : obtenga información detallada del vuelo, incluidos los detalles de la ruta, los horarios de salida y llegada, los detalles de la aeronave y la disponibilidad de asientos. Filtre la lista de vuelos por fechas de salida y llegada para mayor comodidad.

• Estado del pedido : los usuarios autenticados pueden revisar la información de su pedido.

• Detalles del boleto : facilita la adición de boletos de avión, lo que permite a los usuarios especificar números de fila y asiento para el pedido.

• Mecanismo de autenticación : los usuarios pueden crear perfiles proporcionando una dirección de correo electrónico y una contraseña. La API emplea autenticación JWT (JSON Web Tokens) para proteger los datos confidenciales de los vuelos.