GWLocationAPI

GWLocationAPI

Um incrível projeto de amostra/bootstrap de API RESTful Python e Flask com um toque de OOP e MVC, testes de unidade, persistência via SQLAlchemy, segurança e autenticação, mashups e alguns outros tópicos interessantes em um único pacote.

---

Trabalho em andamento

Este é um trabalho em andamento...

---

Configurar

Etapas rápidas para começar:

• Clone este projeto no terminal/prompt de comando: git clone https://github.com/RHT/GWLocationAPI.git
• Execute virtualenv venv (Saiba mais sobre como configurar seu próprio ambiente virtual - leia minhas instruções abaixo: Como configurar um ambiente virtual? )
• Ative a source venv/bin/activate (Mac/Linux) ou ./venv/Scripts/activate.bat ( Windows )
• Instale os requisitos predefinidos pip install -r requirements.txt
• Execute o aplicativo python app.py
• Abra http://localhost:5000/ (siga todas as outras instruções neste documento para ver como fazer um teste).
• Para uma visualização ao vivo, consulte: https://gw-location-api.herokuapp.com e teste fazer chamadas diferentes.

Como configurar um ambiente virtual?

Instale virtualenv a partir do seu terminal/prompt de comando

Mac/Linux/Windows: pip install virtualenv ou pip3.6 install virtualenv

Inicializar virtualenv

Isso inicializará virtualenv no diretório do seu projeto.

Mac/Linux/Windows: virtualenv venv ou virtualenv venv --python=3.6

Para ativar virtualenv

Isso ativará seu ambiente virtual. Todos pip install s dentro do diretório do seu projeto afetarão apenas o seu ambiente virtual e não o seu sistema.

Mac e Linux: source venv/bin/activate

Windows: ./venv/Scripts/activate.bat

Como desativo o ambiente virtual do meu projeto?

Para parar/desativar virtualenv

Isso interromperá sua sessão no ambiente virtual.

Enquanto estiver dentro do diretório do seu projeto, digite o seguinte (Mac/Linux/Windows): deactivate

---

Testando através de cURL

OBTER ÍNDICE

curl "https://gw-location-api.herokuapp.com"

ENCONTRE LOCALIZAÇÃO

curl "https://gw-location-api.herokuapp.com/find/bangkok"

OBTENHA TODOS OS LOCAIS

curl "https://gw-location-api.herokuapp.com/locations/"

LOCALIZAÇÃO POR ID

curl "https://gw-location-api.herokuapp.com/locations/1"

LOCALIZAÇÃO DO PÓS (?)

curl -i -X "POST" "https://gw-location-api.herokuapp.com/locations/"

ATUALIZAR LOCAL (?)

curl -i -X "PUT" "https://gw-location-api.herokuapp.com/locations/1"

EXCLUIR LOCAL (?)

curl -i -X "DELETE" "https://gw-location-api.herokuapp.com/locations/1"

? = Requer autenticação ( crie um usuário dentro do arquivo db gerado até ser adicionado em versões futuras ).

---

Executando um teste de unidade

Execute python tests/model/test_user.py

---

Amostra ao vivo

https://gw-location-api.herokuapp.com

---

Licença

Direitos autorais ©2018 – Roberth Hansson-Tornéus (RHT)