This project is an Airport API Service built with Django and Docker, providing RESTful APIs for managing various entities such as Crew, Countries, Cities, Airports, Airplane Types, Airplanes, Routes, Flights, Users, Orders.
To run the project with Docker, follow these steps:
-
Clone the repository:
git clone https://github.com/paashkovaaa/airport-api-service.git
-
Navigate to the project directory:
cd airport-api-service -
Build and run the Docker containers:
docker-compose up --build
-
Access the API endpoints via
http://localhost:8000/.
To run the project on your local machine without Docker, follow these steps:
-
Ensure you have Python installed (preferably version 3.7 or later).
-
Clone the repository:
git clone https://github.com/paashkovaaa/airport-api-service.git
-
Navigate to the project directory:
cd airport-api-service -
Install the Python dependencies:
pip install -r requirements.txt
-
Apply database migrations:
python manage.py migrate
-
Run the development server:
python manage.py runserver
-
Access the API endpoints via
http://localhost:8000/.
-
/api/doc/swagger/- Provides the Swagger UI interface for interactive documentation of the API endpoints. Developers can explore and test the endpoints directly from the browser.
-
Redoc Documentation:
/api/doc/redoc/- Offers the Redoc interface for API documentation, providing an alternative layout and styling for viewing and interacting with the API documentation.
Below is a summary of the API endpoints provided by the project:
- Crews:
/api/airport/crews/ - Countries:
/api/airport/countries/ - Cities:
/api/airport/cities/ - Airports:
/api/airport/airports/ - Airplane Types:
/api/airport/airplane_types/ - Airplanes:
/api/airport/airplanes/ - Routes:
/api/airport/routes/ - Flights:
/api/airport/flights/ - Orders:
/api/airport/orders/ - Users:
/api/user/register,/api/user/me/api/user/token,/api/user/token/refresh,/api/user/token/verify
Each endpoint supports various operations such as listing, creation, retrieval, and updating of resources.