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 令牌）身份驗證來保護敏感的航班資料。