Airport API

Aeroporto-API

O serviço Airport API, construído em Django REST, é criado especificamente para monitorar voos originados de aeroportos em todo o mundo. Fornecendo detalhes abrangentes sobre aeroportos, aviões, voos, rotas e muito mais, esta API funciona como uma ferramenta poderosa para gerenciar e analisar com eficácia dados associados a viagens aéreas.

Instalando usando GitHub

Antes de começar, certifique-se de atender aos seguintes requisitos:

• Instale o PostgresSQL e crie o banco de dados
• Python3 já deve estar instalado.

Execute o projeto localmente sem Docker

Instalado

1. Clone o repositório:

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

2. Vá para o diretório do projeto:

 cd Airport_API

3. Crie um mecanismo Python virtual e ative-o:

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

4. Defina as atribuições do projeto:

pip install -r requirements.txt

Variáveis ​​de ambiente de configuração:

• Crie um arquivo chamado .env, usando .env.sample como exemplo.
• Certifique-se de ter substituído todas as chaves fictícias pelos seus dados reais.

 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 > 

Iniciando o servidor

1. Crie migrações de banco de dados:

python maange.py makemigrations
python manage.py migrate

2. Carregar dados no banco de dados:

python manage.py loaddata data_base.json

3. Inicie o servidor de desenvolvimento:

python manage.py runserver

A API agora deve estar acessível em http://localhost:8000/

EXECUTAR com Docker

Docker deve estar instalado

docker-compose build

docker-compose up

Obtendo acesso

• criar usuário api/usuário/registro/

• obter token de acesso api/usuário/token/

• Para autenticar, inclua o token obtido nos cabeçalhos da sua solicitação com o formato:

 - Authorization: Bearer < your-token > 

Documentação da API

• A API é documentada usando o padrão OpenAPI.
• Acesse a documentação da API executando o servidor e navegando para http://localhost:8000/api/doc/swagger/ ou http://localhost:8000/api/doc/redoc/.

Características do projeto:

• Restrição de informações : A comunicação entre administradores e usuários regulares é limitada, garantindo que os usuários acessem apenas as informações autorizadas.

• Detalhes do aeroporto : recupere dados abrangentes sobre aeroportos globais, incluindo nomes, códigos de aeroportos e proximidade das principais cidades e países.

• Informações sobre rotas : acesse detalhes sobre diferentes rotas, incluindo nomes de aeroportos de partida e destino, além da distância entre eles.

• Detalhes do avião : recupere informações sobre o avião, como nomes, tipos, contagens de fileiras de passageiros e números de assentos por fileira. O sistema inclui uma função integrada para baixar e armazenar imagens de aviões.

• Visão geral do voo : obtenha informações detalhadas do voo, incluindo detalhes da rota, horários de partida e chegada, detalhes da aeronave e disponibilidade de assentos. Filtre a lista de voos por datas de partida e chegada para maior comodidade.

• Status do pedido : usuários autenticados podem revisar as informações do pedido.

• Detalhes da passagem : facilita a adição de passagens aéreas, permitindo que os usuários especifiquem números de filas e assentos para o pedido.

• Mecanismo de autenticação : os usuários podem criar perfis fornecendo um endereço de e-mail e uma senha. A API emprega autenticação JWT (JSON Web Tokens) para proteger dados confidenciais de voo.