Advertisement
  1. Code
  2. Flask

Construindo APIs RESTful Com Flask: ORM Com SQLAlchemy

by
Difficulty:BeginnerLength:ShortLanguages:
This post is part of a series called Building RESTful APIs With Flask.
Building RESTful APIs With Flask: The DIY Approach
Building RESTful APIs With Flask: ORM Independent

Portuguese (Português) translation by Erick Patrick (you can also view the original English article)

Na primeira parte dessa série, vimos como criar APIs RESTful por conta própria usando Flask como a framework Web. A abordagem anterior deu-nos bastante flexibilidade mas também requereu muito código, que poderia ser evitado em casos mais genéricos.

Agora, usaremos uma extensão do Flask, Flask-Restless, que gera APIs RESTful para modelos de banco de dados definidos com SQLAlchemy. Usaremos a mesma aplicação exemplo da parte anterior para manter o contexto e dar continuidade.

Instalando Dependências

Embora continuemos a aplicação do tutorial anterior, precisamos instalar uma nova dependência:

A Aplicação

Flask-Restless facilita a adição APIs RESTful para modelos criados com SQLAlchemy. Primeiro, adicionemos o APIManager da extensão flask.ext.restless ao arquivo de configuração da aplicação.

flask_app/my_app/__init__.py

Adicionar essas poucas linhas ao nosso código já existente deve servir.

flask_app/my_app/catalog/views.py

Esse arquivo compreende as maiores mudanças em relação artigo anterior. Abaixo, temos o arquivo completamente reescrito.

O funcionamento do código acima é autoexplicativo. Apenas importamos o manager que criamos no arquivo anterior e usamo-no para criar uma API para o modelo Product com os métodos (methods) listados. Podemos adicionar mais métodos como o DELETE, PUT, PATCH, etc., se precisarmos.

Aplicação em Ação

Testemos essa aplicação criando alguns produtos e listando-os. O ponto de acesso criado pela extensão é, por padrão, http://localhost:5000/api/product.

Como fizemos no tutorial anterior, testaremos usando a biblioteca requests através do terminal.

Como Customizar

É uma mão na roda ter as APIs RESTful criadas automaticamente, mas cada aplicação possui lógica de negócio própria que requer customização, validação e manipulação de requisições, etc.

Eis que preprocessors e postprocessors de requisições vem ao resgatte. Como o nome implica, métodos designados como pré-processadores exeutam antes do processamento da requisição e os pós-processadores executam após a requisição. create_api() é onde devemos colocá-los, na forma de dicionário para o tipo de requisição (GET, POST, etc.) e os métodos como listas que agirão como pré- ou pós-processadores na requisição especificada. Abaixo temos um modelo:

Requisições GET, PUT e PATCH tem a flexibilidade de serem disparadas para registros únicos ou múltiplos, assim, possuem dois tipos cada. No código acima, note GET_SINGLE e GET_MANY para requisições GET.

Os pré- e pós-processadores aceitam diversos tipos de parâmetros para cada tipo de requisição e funcionam sem qualquer retorno. Experimente essa parte por conta própria ;).

Conclusão

Nesse tutoral, vimos como criar uma API RESTful usando Flask ao adicionar algumas poucas linhas de código ao modelo baseado em SQLAlchemy.

Na próxima parte (e última), cobriremos como criar uma API RESTful usando outra extensão popular do Flask mas, dessa vez, a API será independente da ferramenta de modelagem usada para a base de dados.

Advertisement
Advertisement
Advertisement
Advertisement
Looking for something to help kick start your next project?
Envato Market has a range of items for sale to help get you started.