Variáveis em Python
13/06/2021
Python Args e Kwargs: Guia Completo e Detalhado para Iniciantes
26/03/2023
Aprender a criar uma API é uma habilidade fundamental para qualquer desenvolvedor que deseje trabalhar com troca de informações entre sistemas ou aplicações. Neste artigo, você aprenderá a criar sua primeira API em Python de forma simples e descomplicada. O tutorial é voltado para iniciantes e também programadores avançados, com exemplos práticos que abordam diferentes tipos de chamadas, chamadas com variáveis e o essencial para dar seus primeiros passos no desenvolvimento de APIs.
Siga este tutorial para aprender tudo o que você precisa saber sobre como começar a criar APIs em Python e se preparar para novos desafios no mundo do desenvolvimento web.
Entendendo o que é uma API em Python
Antes de mergulharmos no desenvolvimento da API em Python, é crucial entender o que é uma API. A sigla API significa Application Programming Interface, ou Interface de Programação de Aplicações. Simplificando, uma API é um conjunto de regras e protocolos que permite a comunicação entre diferentes sistemas ou aplicações. Ao criar uma API em Python, você estará construindo uma interface que permitirá que outros sistemas ou aplicativos interajam com o seu código Python de maneira fácil e organizada.
Por que criar uma API em Python?
Existem muitas razões pelas quais você pode querer criar uma API em Python. Uma API pode ser usada para permitir que outros desenvolvedores acessem e usem os recursos de seu aplicativo ou site, permitindo que você crie um ecossistema de aplicativos e serviços interconectados. Isso pode aumentar a visibilidade e o alcance de seu aplicativo, além de criar novas oportunidades de receita. Além disso, a criação de uma API bem projetada pode tornar seu aplicativo ou site mais escalável e fácil de manter
Escolhendo o framework: Flask para criar APIs em Python
Existem vários frameworks disponíveis para criar APIs em Python, como Django, FastAPI e Flask. Neste tutorial, optaremos pelo Flask devido à sua simplicidade e facilidade de uso. O Flask é um microframework leve que permite criar aplicações web em Python de maneira rápida e sem burocracia. Vamos começar instalando o Flask:
pip install flask
Ao executar este comando, você instalará o Flask no seu ambiente de desenvolvimento Python usando o gerenciador de pacotes pip. Com o Flask instalado, podemos criar nossa primeira API em Python.
Iniciando o projeto
app.py. Nele, adicione o seguinte código:
from flask import Flask, jsonify
app = Flask(__name__)
@app.route('/')
def hello_world():
return jsonify(message='Ola, mundo!')
if __name__ == '__main__':
app.run(debug=True)
Vamos entender o que foi feito no código acima, trecho a trecho:
Importando módulos e criando uma instância Flask
from flask import Flask, jsonify app = Flask(__name__)
Neste trecho, importamos duas funções do módulo Flask:
Flask: É a classe principal do framework Flask. Ela nos ajuda a criar uma aplicação web em Python.jsonify: Esta função converte objetos Python em strings JSON, o que facilita o retorno de respostas no formato JSON, comum em APIs.
Em seguida, criamos uma instância da classe Flask e atribuímos à variável app. O argumento __name__ passado para a classe Flask nos ajuda a configurar a aplicação de acordo com as configurações do módulo atual.
Definindo uma rota e função
@app.route('/')
def hello_world():
return jsonify(message='Ola, mundo!')
Executando a aplicação Flask
if __name__ == '__main__':
app.run(debug=True)
app.run() inicia o servidor de desenvolvimento do Flask. Ao passar o argumento debug=True, ativamos o modo de depuração do Flask, que nos fornece informações úteis sobre erros e recarrega automaticamente o servidor sempre que o código é alterado.
Agora que analisamos o código passo a passo, você deve compreender melhor o funcionamento de cada instrução e como elas se relacionam para criar uma API simples em Python usando o Flask. Testando a API em Python
app.py usando o seguinte comando:
python app.pyEm seguida, acesse
http://localhost:5000 no seu navegador. Você deve ver o JSON com a mensagem “Ola, mundo!”. 
Tipos de chamadas e variáveis em APIs em Python
Agora que temos nossa API em Python funcionando, é hora de explorar diferentes tipos de chamadas e como lidar com variáveis.
Métodos HTTP em APIs em Python
As APIs geralmente utilizam métodos HTTP para determinar o tipo de ação a ser executada. Os métodos mais comuns são:
- GET: para recuperar informações
- POST: para criar novos recursos
- PUT: para atualizar recursos existentes
- DELETE: para excluir recursos
Para lidar com diferentes métodos HTTP, o Flask nos permite especificar quais métodos são aceitos por cada rota. Vamos explorar como fazer isso.
Criando rotas para diferentes métodos HTTP
Vamos adicionar algumas rotas à nossa API em Python para demonstrar o uso de diferentes métodos HTTP. Primeiro, importe o módulo request do Flask:
from flask import Flask, jsonify, request
Em seguida, adicione estas rotas ao arquivo app.py:
@app.route('/example', methods=['GET', 'POST'])
def example():
if request.method == 'GET':
return jsonify(message='Você fez uma requisição GET')
elif request.method == 'POST':
return jsonify(message='Você fez uma requisição POST')
/example que aceita requisições GET e POST. Utilizamos a variável request.method para verificar qual método HTTP foi usado e retornar uma mensagem JSON correspondente. Lidando com variáveis em rotas da API em Python
@app.route('/hello/<name>', methods=['GET'])
def hello_name(name):
return jsonify(message=f'Ola, {name}!')
name. Quando acessada com uma URL como http://localhost:5000/hello/João, a API retornará um JSON com a mensagem “Olá, João!”. 
Lidando com múltiplas variáveis em rotas da API em Python
@app.route('/cumprimento/<language>/<name>', methods=['GET'])
def greet_name(language, name):
greetings = {
'pt': 'Ola',
'en': 'Hello',
'es': 'Hola',
'fr': 'Bonjour'
}
greeting = greetings.get(language, 'Ola')
return jsonify(message=f'{greeting}, {name}!')
Esta rota aceita dois parâmetros de caminho: language e name. A variável language corresponde à sigla do idioma, enquanto name é o nome da pessoa a ser cumprimentada. A rota retorna um cumprimento personalizado de acordo com o idioma e o nome fornecidos.
Por exemplo, ao acessar a URL http://localhost:5000/cumprimento/pt/João, a API retornará um JSON com a mensagem “Olá, João!”. Se você alterar o idioma para ‘en’ e acessar http://localhost:5000/cumprimento/en/John, a API retornará “Hello, John!”.
Você também pode lidar com várias variáveis nomeadas utilizando o método request.args para extrair variáveis de consulta (query parameters) da URL. Suponha que você queira criar uma API que recebe múltiplas variáveis nomeadas e retorna a soma dos valores fornecidos. Adicione a seguinte rota ao seu arquivo app.py:
@app.route('/soma', methods=['GET'])
def sum_values():
value1 = int(request.args.get('value1', 0))
value2 = int(request.args.get('value2', 0))
value3 = int(request.args.get('value3', 0))
total = value1 + value2 + value3
return jsonify(message=f'A soma dos valores e {total}')
Neste exemplo, a rota /soma recebe três variáveis nomeadas como parâmetros de consulta: value1, value2 e value3. O método request.args.get() é utilizado para extrair os valores desses parâmetros e atribuí-los às variáveis correspondentes. Em seguida, a rota retorna a soma dos valores fornecidos.
Ao acessar a URL http://localhost:5000/soma?value1=10&value2=20&value3=30, a API retornará um JSON com a mensagem “A soma dos valores é 60”.
Conclusão
Parabéns! Neste tutorial detalhado, você aprendeu a criar sua primeira API em Python usando o Flask. Exploramos cada bloco de código e instrução para garantir que você compreenda completamente o processo. Além disso, abordamos diferentes tipos de chamadas, com ou sem variáveis.
Agora que você possui uma base sólida para criar APIs em Python, você pode aprimorar suas habilidades e expandir seu conhecimento para desenvolver APIs mais avançadas e eficientes. Lembre-se de que a prática leva à perfeição, então continue trabalhando em seus projetos e buscando novos desafios.
