Project_Django_Rest_Framework_Flight_App

✈️ A modern flight booking system API ✈️

Table of Contents

• Table of Contents
• API Documentation
• API Testing
• Overview
• Built With
• How To Use
• About This Project
• Key Features
• Contact

API Documentation

You can access the detailed API documentation of the project from the links below:

• Swagger Documentation

➡ Interface that allows you to easily test API endpoints.

---

• Redoc Documentation

➡ Documentation tool that presents the API structure in a detailed and organized way.

---

Notes: You can access Swagger and Redoc documentation without any user login.

Not: Swagger ve Redoc dokümantasyonlarına herhangi bir kullanıcı girişi yapmadan erişebilirsiniz.

• Along with Swagger and Redoc documentation, you can use our Postman collection to test APIs. Flight Reservation API Postman Collection

API Testing

To test APIs via Postman, you can follow the steps below:

1. Install Postman (if not installed): Download Postman.
2. This Postman Collection Download and import.
3. Start testing APIs via Postman.

Postman Collection Link:
Flight Reservation API Postman Collection

Overview

Flight Reservation App is a modern API solution through which users can manage flight reservations. Main features:

• Flight Management: staff users can add, update and delete flights.
• Reservation Management: staff users can view all reservations, users can manage their own reservations.
• Anonymous Access: Unregistered users can only view future flights.
• Advanced User Authorization: Users have the ability to change passwords and manage their own booking processes.
• API Documentation with Swagger and Redoc: Ability to examine and test the API structure in detail.
• PostgreSQL Support: Powerful and reliable database support in the Production environment.

---

Flight Reservation App, kullanıcıların uçuş rezervasyonlarını yönetebileceği modern bir API çözümüdür. Başlıca özellikler:

• Uçuş Yönetimi: staff kullanıcılar uçuşları ekleyebilir, güncelleyebilir ve silebilir.
• Rezervasyon Yönetimi: staff kullanıcılar tüm rezervasyonları görüntüleyebilir, kullanıcılar kendi rezervasyonlarını yönetebilir.
• Anonim Erişim: Kayıtlı olmayan kullanıcılar sadece gelecekteki uçuşları görüntüleyebilir.
• Gelişmiş Kullanıcı Yetkilendirme: Kullanıcılar şifre değiştirme ve kendi rezervasyon işlemlerini yönetme yeteneğine sahiptir.
• Swagger ve Redoc ile API Dokümantasyonu: API yapısını detaylı inceleme ve test etme olanağı.
• PostgreSQL Desteği: Production ortamında güçlü ve güvenilir veritabanı desteği.

---

• Project Swagger and Redoc Documentation Visual

➡ Interface that allows you to easily test API endpoints.

---

• user/authentication app testing on Postman

➡ User registration process screen.

---

• Flight app testing on Postman

➡ Flight booking test with Postman.

---

• user/authentication app testing on Postman

---

• user/authentication app testing on Postman

---

• user/authentication app testing on Postman

---

• user/authentication app testing on Postman

---

• API documentation is detailed with Swagger and Redoc. You can access the relevant links via Swagger and Redoc.

• Flight Reservation App is a modern backend application developed to enable users to manage flight reservations and provide easy integration with API documentation.

• Provides CRUD operations specific to users and staff roles.

• Swagger and Redoc were used for API documentation.

Built With

• Django Rest Framework - A powerful framework for developing REST APIs.
• Swagger And Redoc - API documentation and testing tools.
• Debug_Toolbar - A powerful tool for debugging operations.
• Logging - System logging modul
• dj-rest-auth - User authentication and authorization.
• PostgreSQL - High performance database for production environment.

How To Use

• For online demo: You can take a look at the Swagger and Redoc interfaces.

• To clone and run this application, you'll need Git

• When installing the required packages in the requirements.txt file, review the package differences for windows/macOS/Linux environments.

• Complete the installation by uncommenting the appropriate package.

---

• For online demo: You can take a look at Swagger or Redoc interfaces.

• requirements.txt dosyasındaki gerekli paketlerin kurulumu esnasında windows/macOS/Linux ortamları için paket farklılıklarını inceleyin.

• Uygun olan paketi yorumdan kurtararak kurulumu gerçekleştirin.

---

# Clone this repository
$ git clone https://github.com/Umit8098/Project_Django_Rest_Framework_Flight_App_CH-12.git

# Install dependencies
    $ python -m venv env
    $ python3.9 -m venv env (for macOs/linux OS)
    $ env/Scripts/activate (for win OS)
    $ source env/bin/activate (for macOs/linux OS)
    $ pip install -r requirements.txt
    $ python manage.py migrate (for win OS)
    $ python3 manage.py migrate (for macOs/linux OS)

# Create and Edit .env
# Add Your SECRET_KEY in .env file

"""
# example .env;

SECRET_KEY =123456789abcdefg...

# for development(dev) environments
DEBUG =True

# PostgreSQL settings for product (product) environments
SQL_DATABASE={your_database_name}
SQL_USER={your_database_user}
SQL_PASSWORD={your_database_password}
SQL_HOST=localhost
SQL_PORT=5432

# for choices environment
ENV_NAME =dev
# ENV_NAME =prod

# Logging level
DJANGO_LOG_LEVEL=INFO
"""

# Run the app
    $ python manage.py migrate
    $ python manage.py runserver

About This Project

This project was developed to modernize flight booking processes and make flight planning easier for users. It aims to provide solutions for the following situations:

• User Needs: Users can manage their own reservations by registering.
• Business Requirements: staff users to manage flights and reservations more efficiently.
• Easy Integration: Easy connection with third-party systems thanks to API documentation.

The following technical approaches and solutions were applied in this project:

• Development Environment: Separate settings for Development and Production environments.
• Performance Optimization: Big data management using PostgreSQL.
• API Documentation: Comprehensive API documentation with Swagger and Redoc.
• User Authorization: Authorization structure suitable for staff and normal user roles.

---

Bu proje, uçuş rezervasyon süreçlerini modernleştirmek ve kullanıcıların uçuş planlamasını kolaylaştırmak amacıyla geliştirilmiştir. Aşağıdaki durumlar için çözüm sunmayı hedefler:

• Kullanıcı İhtiyaçları: Kullanıcıların kayıt olarak kendi rezervasyonlarını yönetebilmesi.
• İşletme Gereksinimleri: staff kullanıcıların uçuşları ve rezervasyonları daha verimli yönetmesi.
• Kolay Entegrasyon: API dokümantasyonu sayesinde üçüncü parti sistemlerle kolay bağlantı kurulması.

Bu projede aşağıdaki teknik yaklaşımlar ve çözümler uygulanmıştır:

• Geliştirme Ortamı: Development ve Production ortamları için ayrı ayarlar.
• Performans Optimizasyonu: PostgreSQL kullanımı ile büyük veri yönetimi.
• API Dokümantasyonu: Swagger ve Redoc ile kapsamlı API dokümantasyonu.
• Kullanıcı Yetkilendirme: staff ve normal kullanıcı rollerine uygun yetkilendirme yapısı.

Key Features

• Flight Reservation Management: Users can view and book flights.
• Staff Authorizations: Staff users can fully control flights and reservations.
• API Documentation: Detailed API documentation with Swagger and Redoc.
• User Authorization: Registration, login, password change and reservation management.
• PostgreSQL Support: High performance database in production environment.

---

• Uçuş Rezervasyon Yönetimi: Kullanıcılar uçuşları görüntüleyebilir ve rezervasyon yapabilir.
• Staff Yetkileri: Staff kullanıcılar uçuş ve rezervasyonları tam kontrol edebilir.
• API Dokümantasyonu: Swagger ve Redoc ile detaylı API dokümantasyonu.
• Kullanıcı Yetkilendirme: Kayıt, giriş, şifre değiştirme ve rezervasyon yönetimi.
• PostgreSQL Desteği: Production ortamında yüksek performanslı veritabanı.

Contact

• GitHub @Umit8098

• LinkedIn @umit-arat