Вы находитесь на странице: 1из 14

DEVACADEMY

CRIANDO
UMA API NO
FLASK

APRENDA A CRIAR SUA PRÓPRIA API


COMO CRIAR UMA API RESTFUL EM FLASK EM POUCOS
PASSOS.
DEVACADEMY

CRIANDO
UMA API NO
FLASK

APRENDA A CRIAR SUA PRÓPRIA API


COMO CRIAR UMA API RESTFUL EM FLASK EM POUCOS
PASSOS.
COMO INICIAR
PRIMEIROS PASSOS PARA ENTENDER E ORGANIZAR
O NOSSO AMBIENTE DE DESENVOLVIMENTO

1
FUNDAMENTOS

2
AMBIENTE
VIRTUAL

3
CRIANDO UM
HELLO WORLD!

4
CRIANDO
UMA API RESTFUL
SIMPLES
Fundamentos
O que é o Flask?

Flask tem a flexibilidade da linguagem de programação Python e provê um


modelo simples para desenvolvimento web. Uma vez importando no Python,
Flask pode ser usado para economizar tempo construindo aplicações web.

É chamado de microframework porque mantêm um núcleo simples mas


estendível. Não há uma camada de abstração do banco de dados, validação
de formulários, ou qualquer outro componente onde bibliotecas de terceiros
existem para prover a funcionalidade. Assim, Flask suporta extensões capazes
de adicionar tais funcionalidades na aplicação final. Há uma vasta coleção de
bibliotecas para resolver essas questões em Python, isso simplifica o
framework e torna sua curva de aprendizado mais suave.

Configurações e Instalações
Existe uma série de recursos que você precisa ficar atento para que funcione
corretamente em seu computador.
Neste E-book vamos utilizar os comandos e configurações padrão para o
Windows, porém você consegue facilmente encontrar essa informação para o
Linux / Mac.

1
Configurando o Python e as variáveis de ambiente
Caso você não tenha o Python instalado na sua máquina:

Baixe o executável de instalação do Python:


https://www.python.org/download/releases/2.7/
Faça a instalação seguindo os passos necessários;

Em seguida instale o PIP:


http://cyz.github.io/python/2016/09/02/instalando-o-pip-no-windows.html;

Caso não consiga instalar nesse link, pesquise como instalar PIP no Python 2.7.

Agora estamos prontos para começar a organizar nosso ambiente de


desenvolvimento.

2
Ambiente Virtual
Criando um ambiente Flask
Antes de prosseguir vamos instalar o virtualenv que é usado para isolar o
ambiente do Flask, para isso entre no CMD do Windows / Terminal do
Linux/MacOS e faça a instalação usando o seguinte comando:

python.exe -m pip install virtualenv

Aguarde a instalação e vamos configurar o ambiente de fato, seguindo os


seguintes passos:

Primeiro crie uma pasta no local onde deseja criar o projeto;


Entre na pasta que você acabou de criar;
Crie 2 arquivos nessa pasta: __init__.py e app.py
Execute o seguinte comando:
C:\Python27\Scripts\virtualenv.exe nome_do_projeto_env
Após terminar de criar o ambiente você deve ir na pasta e ativar o
ambiente da seguinte forma:
nome_do_projeto_env\Scripts\activate
Caso o comando tenha sido realizado com sucesso você deve ver o
terminal da seguinte forma:
(nome_do_projeto_env) seuuser@suamaquina/path/to/pasta$
Por fim, instale o Flask:
pip install Flask

3
Criando os arquivos do projeto
Agora vamos seguir esses passos para criar nosso primeiro projeto:

md Projeto01
cd Projeto01
. > __init__.py
. > app.py
C:\Python27\Scripts\virtualenv.exe pj1_env
pj1_env\Scripts\activate

Seu terminal deve ficar assim:


(pj1_env) C:\Users\seu\caminho\aqui\projeto01>

E instale o Flask
pip install Flask

4
CRIANDO UM HELLO
WORLD!
Criando seu primeiro WebApp
Já temos nosso ambiente configurado e vamos executar o nosso primeiro
WebApp da seguinte forma:

Abrar o arquivo que criamos com seu editor de código preferido;


Escreva o seguinte código:

1. # coding: utf-8
2. from flask import Flask
3.
4. app = Flask(__name__)
5.
6. @app.route("/")
7. def ola_mundo():
8. return "Olá Mundo! Esse é meu primeiro WebApp!", 200
9.
10. app.run()

Entendendo a nossa primeira aplicação web:


Linha 1 – Definimos a codificação do texto em utf-8 (Padrão para acentuação
Brasileira)
Linha 2 – É a importação do framework Flask
Linha 4 – É a criação do nosso aplicativo Web, e passamos como parâmetro o nome
do projeto em questão, que nesse caso estamos utilizando uma variável de
ambiente para carregar o nome do arquivo. Se preferir use app = Flask(“projeto01”).
Linha 5 – É um decorator para definirmos a rota dessa função, nesse caso é a nossa
index.
Linha 7 – Criamos uma função simples em Python para atribuir a nossa rota, ou seja,
ao iniciar o projeto web essa função será chamada.
Linha 8 – É o resultado que será apresentado na nossa página principal da nossa
aplicação web.
Linha 10 – Agora que a nossa aplicação está pronta, podemos “rodá-la” usando o
comando app.run()
5
Iniciando a página
Para executar nossa primeira página, vamos no terminal e executamos o
arquivo app.py:

(pj1_env) C:\Users\seu\caminho\aqui\projeto01> python app.py

E deve apresentar a seguinte mensagem:

* Serving Flask app "app" (lazy loading)


* Environment: production
WARNING: Do not use the development server in a production environment.
Use a production WSGI server instead.
* Debug mode: off
* Running on http://127.0.0.1:5000/ (Press CTRL+C to quit)

Copie o endereço que foi impresso no terminal e cole-o no seu navegador, e


você deve ver sua primeira aplicação em pleno funcionamento!

E se quiser parar a aplicação para fazer qualquer alteração, você vai até o
terminal que está com essa mensagem e pressione CTRL (Comand) + C, como
está apresentado no terminal.

6
CRIANDO UMA API
RESTFUL SIMPLES
O que é RESTful?
A Representational State Transfer (REST), em português Transferência de
Estado Representacional, é um estilo de arquitetura que define um conjunto
de restrições e propriedades baseados em HTTP.

Web Services que obedecem ao estilo arquitetural REST, ou web


services RESTful, fornecem interoperabilidade entre sistemas de
computadores na Internet.

Os web services compatíveis com REST permitem que os sistemas solicitantes


acessem e manipulem representações textuais de recursos da Web usando
um conjunto uniforme e predefinido de operações sem estado.

Outros tipos de web services, como web services SOAP, expõem seus próprios
conjuntos arbitrários de operações.

Criando uma API


Agora que já sabemos o que é a tecnologia RESTful, podemos partir para um
código simples:

Crie um arquivo novo chamando api.py, abra-o no seu editor de código;


Escreva o seguinte código:

7
1. # coding: utf-8
2. from flask import Flask, jsonify, make_response
3.
4. app = Flask(__name__)
5.
6. @app.route("/")
7. def api():
8. return make_response(
jsonify({'MinhaAPI': 'Acabei de criar uma API simples, em poucos
minutos!'}), 200
)
9.
10. app.run()

Ao acessar a página através do Postman (https://www.getpostman.com/) ou


de qualquer serviço de consumo do tipo RESTful, você terá a mensagem
indicada na API!

8
Próximos passos
O objetivo desse E-book foi atingido, agora é a hora de ir em frente, caso ainda
não tenha curtido a nossa página no Facebook, sugiro fazer agora mesmo e
aproveitar outros conteúdos.

Acesse: https://www.facebook.com/devacademybr

Livro
Caso tenha interesse em continuar aprendendo a
desenvolver neste incrível framework, aconselho a comprar o
meu livro:

Guia Prático: Python & Flask

Acessando: https://amzn.to/2RpauIz

Neste livro eu abordo:


> Criando site com Flask;
> Criando Sistema para Pizzaria em Flask;
> Acesso a banco de dados;
> E muito mais!!

9
Curso completo do Zero ao Profissional
Se você não gosta de aprender através de Livros, então que tal aprender com
vídeos?

Isso mesmo, acessando o site:


https://cursoflask.devacademybr.com/

Você terá acesso a mais de 10 horas de curso em vídeo, além disso, você
receberá um acompanhamento pessoal através de uma mentoria exclusiva
para quem comprar até dia 31 de Janeiro de 2019!!

No curso você vai aprender:


> Principais conceitos do framework;
> Utilizar o framework de css Bootstrap em seus projetos;
> Criar sistemas com banco de dados relacional (mysql, sqlite);
> Criar sistemas com banco de dados não relaciona (mongodb);
> E muito mais!!

CUPOM DE DESCONTO
Utilize o cupom abaixo para ganhar um
MEGA desconto de 50%
Válidos até o dia
31 de Janeiro de 2019

SUPERVIPDESCONTO

10
Obrigado
por baixar este
E-book

11