🚖 Aluguel de Carros REST API

🚧 Concluído ✔️

Tabela de Conteúdos

• Sobre o projeto
• Funcionalidades
• Tecnologias
• Como executar o projeto
  • Pré-requisitos
  • Configurações iniciais
  • Rodando o Backend (servidor)
  • Testando a aplicação com Swagger
• Autora

💻 Sobre o projeto

Aluguel de Carros é uma API REST para sistemas de locação de veículos.

Projeto desenvolvido para compor portfólio de desenvolvimento.

⚙️ Funcionalidades

A aplicação permite que os usuários realizem:

• Interações com usuários:

  • Cadastros de clientes e funcionários
  • Login e logout
  • Buscas personalizadas
  • Exclusão de cadastros

• Interações com marcas e veículos:

  • Registro de marcas e veículos
  • Buscas personalizadas
  • Aluguel e retorno de veículos
  • Exclusão de cadastros

🛠️ Tecnologias

O projeto foi desenvolvido utilizando as seguintes ferramentas:

• Python --versão: 3.7
• Flask --versão: 1.1
• Flask-JWT-Extended --versão: 3.24
• Flask-RESTful --versão: 0.3
• Flask-RESTful-Swagger --versão: 0.2
• Flask-SQLAlchemy --versão: 2.4
• SQLAlchemy --versão: 1.3
• MySQL Workbench --versão: 8.0
• SQLite --versão: 3.31
• PyMySQL --versão: 0.10

🚀 Como executar o projeto

Este projeto foi desenvolvido em uma única parte contendo o Backend (para server) da aplicação.

Para rodar a aplicação, precisarão ser feitas algumas configurações iniciais na máquina.

💡 Para fins de teste dos endpoints, a aplicação de backend deverá estar sendo executada localmente.

Pré-requisitos

Antes de começar, você precisará ter instalado em sua máquina o Python. Além desta ferramenta, caso deseje trabalhar com o código, também é recomendável ter um editor para códigos, como o VSCode; ou uma IDE Python, como o PyCharm.

Será necessário, também, fazer dowload do projeto aluguel-carros.

🔧 Configurações iniciais

A app foi construída em cima de um ambiente virtual contendo os pacotes necessários para o funcionamento desta API. Para configurar um ambiente virtual e executar o código, no terminal/cmd:

# Acesse a pasta do projeto (insira o endereço completo)
$ cd C:\..\aluguel-carros-master

# Crie um ambiente virtual (utilizando python 3.7)
$ virtualenv venv --python=python3.7

# Acesse o ambiente virtual
$ venv\Scripts\activate.bat

Feito isso, o terminal indicará a inicialização do ambiente virtual inserindo (venv) na linha de comando. Seu terminal deverá aparecer da seguinte forma:

$ (venv) C:\..\aluguel-carros-master>_

Em seguida, instale os pacotes no ambiente virtual utilizando o pip install. Eles trabalharão junto com o python na execução do código:

$ pip install FLask
$ pip install Flask-RESTful
$ pip install Flask-JWT-Extended
$ pip install Flask-SQLAlchemy
$ pip install Flask-RESTful-Swagger
$ pip install PyMySQL

Com essas configurações, sua máquina estará apta para executar a aplicação.

🎲 Rodando o Backend (servidor)

Para iniciar a aplicação:

• Com banco de dados SQLite:

  Caso não possua o MySQL instalado em sua máquina, é possível ter acesso ao código com o SQLite.

  Para isso, basta executar o código sem inserir nenhum parâmetro na linha de comando. O SQLite funcionará como banco de dados default.

$ python .\code\app.py

• Com banco de dados MySQL:

  Para executar com banco MySQL, você deverá criar um banco com nome aluguelcarros_db.

  Em seguida, basta inserir os parâmetros de entrada --db=, --dbuser= e --dbpassword na linha de comando.

  Nos campos <USUÁRIO> e <SENHA> devem ser inseridos os seus dados de acesso ao MySQL.

$ python .\code\app.py --db=mysql --dbuser=<USUÁRIO> --dbpassword=<SENHA>

O servidor iniciará em host=localhost e port=5000.

Acesse inserindo http://localhost:5000/ na barra de endereços do seu browser, ou clicando aqui.

🔑 Testando a aplicação com Swagger

Todo o código desta aplicação encontra-se documentado no Swagger.

💡 Para ter acesso à documentação e testar os endpoints da aplicação, é necessário que o código esteja em execução na máquina.

Acesse a documentação em formato JSON. Ou:

🦸 Autora

Raquel Câmara Porto 🍁