A documentação com instruções de uso para requisições à API pode ser encontrada aqui.
Esse repositório serve para ilustrar a construção de APIs com Flask em Python. Testes utilizando a biblioteca Pytest também foram adicionados.
Para executar, é preciso ter as dependências (Flask e Pytest) instaladas e executar o seguinte comando:
python3 -m backend
Você pode optar por instalar as dependências direto na sua máquina com o pip, ou utilizar um ambiente virtual (fortemente recomendado).
Basta utilizar o comando:
python3 -m pytest
Um ambiente virtual serve para que nele seja possível encapsular os pacotes utilizados na API a fim de que eles não "poluam" sua máquina. Utilizar esses ambientes também se mostram úteis no processo de automatização da instalação das dependências do projeto, além de evitar interferências em pacotes de outros projetos.
- Crie o ambiente virtual
python3 -m venv venv
- Ative o ambiente virtual
source venv/bin/activate
- Instale os pacotes (Flask e Pytest) presentes no requirements.txt
pip install -r requirements.txt
Para desativar o ambiente virtual, basta digitar o comando
deactivate