Airport API

Аэропорт-API

Служба Airport API, созданная на основе Django REST, специально создана для мониторинга рейсов, отправляющихся из аэропортов по всему миру. Предоставляя подробную информацию об аэропортах, самолетах, рейсах, маршрутах и ​​т. д., этот API выступает в качестве мощного инструмента для эффективного управления и анализа данных, связанных с авиаперелетами.

Установка с помощью GitHub

Прежде чем начать, убедитесь, что вы выполнили следующие требования:

• Установите PostgresSQL и создайте базу данных.
• Python3 должен быть уже установлен.

Запустите проект локально без Docker

Установлено

1. Клонируем репозиторий:

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

2. Перейдите в каталог проекта:

 cd Airport_API

3. Создайте виртуальный движок Python и активируйте его:

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

4. Установите назначения проекта:

pip install -r requirements.txt

Переменные среды конфигурации:

• Создайте файл с именем .env, используя в качестве примера .env.sample.
• Убедитесь, что вы заменили все фиктивные ключи своими фактическими данными.

 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 > 

Запуск сервера

1. Создайте миграцию базы данных:

python maange.py makemigrations
python manage.py migrate

2. Загрузить данные в БД:

python manage.py loaddata data_base.json

3. Запустите сервер разработки:

python manage.py runserver

Теперь API должен быть доступен по адресу http://localhost:8000/.

ЗАПУСК с Docker

Docker должен быть установлен

docker-compose build

docker-compose up

Получение доступа

• создать пользователя API/пользователь/регистрация/

• получить токен доступа api/user/token/

• Для аутентификации включите полученный токен в заголовки запроса в формате:

 - Authorization: Bearer < your-token > 

API-документация

• API документируется с использованием стандарта OpenAPI.
• Получите доступ к документации API, запустив сервер и перейдя по адресу http://localhost:8000/api/doc/swagger/ или http://localhost:8000/api/doc/redoc/.

Особенности проекта:

• Ограничение информации : общение между администраторами и обычными пользователями ограничено, что гарантирует доступ пользователей только к разрешенной информации.

• Подробная информация об аэропортах : получение полных данных об аэропортах мира, включая названия, коды аэропортов и близость к крупным городам и странам.

• Информация о маршруте : доступ к подробной информации о различных маршрутах, включая названия аэропортов отправления и назначения, а также расстояние между ними.

• Сведения о самолете : получение информации о самолетах, такой как их названия, типы, количество пассажирских рядов и количество мест в ряду. В систему включена встроенная функция загрузки и хранения изображений самолетов.

• Обзор рейса : получите подробную информацию о рейсе, включая особенности маршрута, время вылета и прибытия, информацию о самолете и наличие мест. Для дополнительного удобства отфильтруйте список рейсов по датам вылета и прибытия.

• Статус заказа : авторизованные пользователи могут просматривать информацию о своем заказе.

• Детали билета : облегчает добавление авиабилетов, позволяя пользователям указывать номера рядов и мест для заказа.

• Механизм аутентификации : пользователи могут создавать профили, указав адрес электронной почты и пароль. API использует аутентификацию JWT (JSON Web Tokens) для защиты конфиденциальных полетных данных.