APIs com Python - Área de Trampo

– Web
3 – APIs
3.1 – REST (requests, Django REST Framework)
3.2 – GraphQL (Graphene)

LEGENDA

Nivel_1

Nivel_2

Nivel_3

API significa Interface de Programação de Aplicações. Ela permite que dois softwares se comuniquem de forma padronizada. Primeiramente, APIs são essenciais para arquitetura moderna de software. Por exemplo, seu site pode buscar dados do Google Maps via API. Além disso, APIs podem ser REST, GraphQL ou WebSockets. A voz passiva é usada aqui: “os dados são trocados geralmente em JSON”. Quando utilizar APIs? Sempre que precisar integrar sistemas diferentes. Também quando você quer expor funcionalidades para terceiros. Python é excelente tanto para consumir quanto para criar APIs. Frameworks como Flask, FastAPI e Django REST Framework dominam. Vamos explorar conceitos, criação e consumo de APIs. Três subtítulos guiarão sua jornada pelo mundo das APIs. Ao final, você construirá sua primeira API funcional.

Conceitos fundamentais de apis rest

REST é o estilo arquitetural mais popular para APIs web. Ele usa os verbos HTTP como ações principais. GET recupera dados, POST cria, PUT atualiza e DELETE remove. Cada recurso é identificado por uma URL única. Por exemplo, /usuarios/42 representa o usuário com id 42. As respostas geralmente vêm no formato JSON (ou XML). A voz passiva é aplicada: “os códigos de status HTTP são usados para indicar resultado”. 200 significa sucesso, 404 recurso não encontrado, 500 erro no servidor. Uma API bem projetada segue esses princípios religiosamente. Quando usar REST? Na grande maioria das aplicações web. É simples, cacheável e compatível com qualquer cliente. A fórmula de maturidade REST (modelo de Richardson) tem três níveis: \(M = N_{\text{URI}} + N_{\text{verbos}} + N_{\text{HATEOAS}}\) Quanto maior o nível, mais robusta é a API. Para começar, foque nos dois primeiros níveis.

Criando uma api com fastapi

FastAPI é o framework moderno para construir APIs em Python. Ele oferece documentação automática e validação de tipos. Primeiro, instale com pip install fastapi uvicorn. Depois, defina rotas e modelos de dados com Pydantic. A velocidade é comparável a Node.js e Go. Quando usar FastAPI? Em projetos novos e de alta performance. Exemplo de uma API completa de tarefas (to-do list):

from fastapi import FastAPI, HTTPException
from pydantic import BaseModel
from typing import List, Optional

app = FastAPI(title="API de Tarefas")

# Modelo de dados
class Tarefa(BaseModel):
    id: Optional[int] = None
    titulo: str
    descricao: str = ""
    concluida: bool = False

# Banco de dados em memória
banco_tarefas = []
contador_id = 1

@app.post("/tarefas", status_code=201)
def criar_tarefa(tarefa: Tarefa):
    global contador_id
    tarefa.id = contador_id
    banco_tarefas.append(tarefa)
    contador_id += 1
    return tarefa

@app.get("/tarefas", response_model=List[Tarefa])
def listar_tarefas():
    return banco_tarefas

@app.get("/tarefas/{tarefa_id}")
def buscar_tarefa(tarefa_id: int):
    for tarefa in banco_tarefas:
        if tarefa.id == tarefa_id:
            return tarefa
    raise HTTPException(status_code=404, detail="Tarefa não encontrada")

@app.put("/tarefas/{tarefa_id}")
def atualizar_tarefa(tarefa_id: int, tarefa_atualizada: Tarefa):
    for i, tarefa in enumerate(banco_tarefas):
        if tarefa.id == tarefa_id:
            tarefa_atualizada.id = tarefa_id
            banco_tarefas[i] = tarefa_atualizada
            return tarefa_atualizada
    raise HTTPException(status_code=404, detail="Tarefa não encontrada")

@app.delete("/tarefas/{tarefa_id}")
def deletar_tarefa(tarefa_id: int):
    for i, tarefa in enumerate(banco_tarefas):
        if tarefa.id == tarefa_id:
            del banco_tarefas[i]
            return {"mensagem": "Tarefa removida"}
    raise HTTPException(status_code=404, detail="Tarefa não encontrada")

from fastapi import FastAPI, HTTPException

from pydantic import BaseModel

from typing import List, Optional

app = FastAPI(title="API de Tarefas")

# Modelo de dados

class Tarefa(BaseModel):

id: Optional[int] = None

titulo: str

descricao: str = ""

concluida: bool = False

# Banco de dados em memória

banco_tarefas = []

contador_id = 1

@app.post("/tarefas", status_code=201)

def criar_tarefa(tarefa: Tarefa):

global contador_id

tarefa.id = contador_id

banco_tarefas.append(tarefa)

contador_id += 1

return tarefa

@app.get("/tarefas", response_model=List[Tarefa])

def listar_tarefas():

return banco_tarefas

@app.get("/tarefas/{tarefa_id}")

def buscar_tarefa(tarefa_id: int):

for tarefa in banco_tarefas:

if tarefa.id == tarefa_id:

return tarefa

raise HTTPException(status_code=404, detail="Tarefa não encontrada")

@app.put("/tarefas/{tarefa_id}")

def atualizar_tarefa(tarefa_id: int, tarefa_atualizada: Tarefa):

for i, tarefa in enumerate(banco_tarefas):

if tarefa.id == tarefa_id:

tarefa_atualizada.id = tarefa_id

banco_tarefas[i] = tarefa_atualizada

return tarefa_atualizada

raise HTTPException(status_code=404, detail="Tarefa não encontrada")

@app.delete("/tarefas/{tarefa_id}")

def deletar_tarefa(tarefa_id: int):

for i, tarefa in enumerate(banco_tarefas):

if tarefa.id == tarefa_id:

del banco_tarefas[i]

return {"mensagem": "Tarefa removida"}

raise HTTPException(status_code=404, detail="Tarefa não encontrada")

Rode com uvicorn main:app --reload e acesse /docs. A documentação interativa do Swagger aparecerá magicamente. Você pode testar todos os endpoints diretamente pelo navegador. Essa API REST completa foi criada em menos de 50 linhas de código.

Consumindo apis com python

Consumir APIs significa fazer requisições de dentro do seu código. A biblioteca requests é a mais popular para isso. Instale com pip install requests para começar. Ela suporta GET, POST, PUT, DELETE e autenticação. Quando consumir APIs? Ao integrar serviços de terceiros. Por exemplo, buscar previsão do tempo ou enviar e-mails. A voz passiva é aplicada: “os parâmetros são passados via dicionário”. Exemplo de consumo da API de tarefas que criamos:

import requests

# URL base da API (assumindo rodando localmente)
BASE_URL = "http://localhost:8000"

# Criar uma nova tarefa (POST)
nova_tarefa = {
    "titulo": "Estudar Python",
    "descricao": "Revisar APIs e FastAPI",
    "concluida": False
}
resposta = requests.post(f"{BASE_URL}/tarefas", json=nova_tarefa)
print("Criada:", resposta.json())

# Listar todas as tarefas (GET)
resposta = requests.get(f"{BASE_URL}/tarefas")
print("Todas as tarefas:", resposta.json())

# Buscar uma tarefa específica (GET com id)
tarefa_id = 1
resposta = requests.get(f"{BASE_URL}/tarefas/{tarefa_id}")
if resposta.status_code == 200:
    print("Tarefa encontrada:", resposta.json())
else:
    print("Erro:", resposta.status_code)

# Atualizar uma tarefa (PUT)
atualizacao = {
    "titulo": "Estudar Python Avançado",
    "descricao": "Incluir asyncio e FastAPI",
    "concluida": True
}
resposta = requests.put(f"{BASE_URL}/tarefas/{tarefa_id}", json=atualizacao)
print("Atualizada:", resposta.json())

# Deletar uma tarefa (DELETE)
resposta = requests.delete(f"{BASE_URL}/tarefas/{tarefa_id}")
print("Delete:", resposta.json())

import requests

# URL base da API (assumindo rodando localmente)

BASE_URL = "http://localhost:8000"

# Criar uma nova tarefa (POST)

nova_tarefa = {

"titulo": "Estudar Python",

"descricao": "Revisar APIs e FastAPI",

"concluida": False

}

resposta = requests.post(f"{BASE_URL}/tarefas", json=nova_tarefa)

print("Criada:", resposta.json())

# Listar todas as tarefas (GET)

resposta = requests.get(f"{BASE_URL}/tarefas")

print("Todas as tarefas:", resposta.json())

# Buscar uma tarefa específica (GET com id)

tarefa_id = 1

resposta = requests.get(f"{BASE_URL}/tarefas/{tarefa_id}")

if resposta.status_code == 200:

print("Tarefa encontrada:", resposta.json())

else:

print("Erro:", resposta.status_code)

# Atualizar uma tarefa (PUT)

atualizacao = {

"titulo": "Estudar Python Avançado",

"descricao": "Incluir asyncio e FastAPI",

"concluida": True

}

resposta = requests.put(f"{BASE_URL}/tarefas/{tarefa_id}", json=atualizacao)

print("Atualizada:", resposta.json())

# Deletar uma tarefa (DELETE)

resposta = requests.delete(f"{BASE_URL}/tarefas/{tarefa_id}")

print("Delete:", resposta.json())

Sempre trate os códigos de status HTTP nas respostas. Use try/except para capturar erros de rede ou timeout. APIs são o alicerce da integração moderna entre sistemas. Domine a criação e o consumo, e você estará pronto para qualquer projeto.

Indice

Conceitos fundamentais de apis rest

Criando uma api com fastapi

Consumindo apis com python

Deixe um comentário Cancelar resposta