EduBrQ/FlaskRestFul

flask-rest-api

Padrão de desenvolvimento restful API - Flask

Tecnologias utilizadas

• Python3 - Uma linguagem de programação que permite trabalhar mais rapidamente.
• Flask - Um microframework para Python baseado em Werkzeug, Jinja 2.
• Virtualenv - Uma ferramenta para criar ambientes virtuais isolados.
• PostgreSQL – Banco de dados do Postgres oferece muitas vantagens aqui.
• Pequenas dependências podem ser encontradas no arquivo requirements.txt na pasta raiz.

Instalação / Uso

• Se você deseja executar sua própria compilação, primeiro certifique-se de ter o python3 globalmente instalado em seu computador. Se não, você pode obter python3 [aqui] (https://www.python.org).

• Depois disso, certifique-se de ter instalado o virtualenv globalmente também. Caso contrário, execute isto:

      $ pip install virtualenv
  

• Clone esse repositorio para o seu PC

      $ git clone https://github.com/EduBrQ/FlaskRestFul.git
  

• Dependencias

  1. Cd em seu repositorio clonado, como tal:

     $ cd FlaskRestFul
     

  2. Crie e ative o seu ambiente virtual em python3:

     $ virtualenv venv  
     

   $ cd venv/scripts/activate
  

• Instale todas as dependencias

  (venv)$ pip install -r requirements.txt
  

• Configurando

• Adicione o seguinte condigo ao arquivo config.py:

  import os
  
  # Você precisa substituir pelos valores apropriados para sua configuração
  basedir = os.path.abspath(os.path.dirname(__file__))
  SQLALCHEMY_ECHO = False
  SQLALCHEMY_TRACK_MODIFICATIONS = True
  SQLALCHEMY_DATABASE_URI = "postgresql://username:SuaSenhaDoPsql@localhost/database_name"
  

• aqui, definimos a configuração que a API estará usando. Também estamos usando o banco de dados postgreSQL. Se você preferir outro banco de dados, basta modificar o valor de acordo.

  exemplo: se você quiser usar o SQLite, você deve modificar esta linha como:

  SQLALCHEMY_DATABASE_URI = "sqlite:///app.db"
  

• Migrações

  Instale o Postgresql. No seu console do psql, crie seu database:

  > CREATE DATABASE flaskapi;
  

  Então, aplique as suas migrações

  (venv)$ python migrate.py db init
  
  (venv)$ python migrate.py db migrate
  

  E finalmente, transfira as suas migrações para persistirem no banco de dados:

  (venv)$ python migrate.py db upgrade
  

  Cada vez que os modelos de banco de dados são alterados, repita os comandos migrar e atualizar.

• Iniciando

  execute o comando:

  (venv)$ python run.py
  

  Agora você pode acessar o aplicativo em seu navegador local usando

  http://127.0.0.1:5000/api/
  

  Ou teste as rotas /Comentarios e /Categorias usando o Postman

• Testando

  Navegue ate a pasta Testes, escolha entre a pasta de testes de integração ou unitarios e execute o comando:

  (venv)$ python nomeTeste.py