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

现在应该可以通过 http://localhost:8000/ 访问该 API

使用 Docker 运行

Docker 应该已安装

docker-compose build

docker-compose up

获取访问权限

• 创建用户 api/user/register/

• 获取访问令牌 api/user/token/

• 要进行身份验证，请将获得的令牌包含在请求标头中，格式如下：

 - Authorization: Bearer < your-token > 

API文档

• 该 API 使用 OpenAPI 标准进行记录。
• 通过运行服务器并导航到 http://localhost:8000/api/doc/swagger/ 或 http://localhost:8000/api/doc/redoc/ 来访问 API 文档。

项目特点：

• 信息限制：管理员和普通用户之间的通信受到限制，确保用户只能访问授权信息。

• 机场详细信息：检索全球机场的综合数据，包括名称、机场代码以及与主要城市和国家的距离。

• 路线洞察：访问有关不同路线的详细信息，包括出发地和目的地机场名称以及它们之间的距离。

• 飞机详细信息：检索有关飞机的信息，例如名称、类型、乘客排数以及每排座位数。该系统包括用于下载和存储飞机图像的内置功能。

• 航班概览：获取详细的航班信息，包括航线详情、出发和到达时间、飞机详细信息和可用座位。按出发和抵达日期过滤航班列表，以更加方便。

• 订单状态：经过身份验证的用户可以查看其订单信息。

• 机票详情：方便添加机票，允许用户指定订单的排号和座位号。

• 身份验证机制：用户可以通过提供电子邮件地址和密码来创建配置文件。该 API 采用 JWT（JSON Web 令牌）身份验证来保护敏感的航班数据。