O que é uma API?

• Integrar sistemas: conectar aplicativos front-end ao back-end.

• Automatizar processos: facilitar a troca de dados entre serviços.

• Criar soluções escaláveis: compartilhar funcionalidades entre múltiplas aplicações.

📽️

E que tal assistir a uma explicação visual e prática? Confira o vídeo abaixo e aprenda, de forma descontraída, o que é uma API e como ela funciona. Dê o play e prepare-se para aprender!

O que é Flask e por que usá-lo?

• Leve: perfeito para quem busca simplicidade e controle.

• Extensível: você adiciona apenas os componentes necessários.

• Ideal para iniciantes: a curva de aprendizado é suave, mas ele é poderoso o suficiente para projetos complexos.

Agora que entendemos o básico, vamos criar sua primeira API do zero.

Começando com Flask

pip install flask

meu_projeto/
├── app.py
└── models/
    └── task.py

Agora estamos prontos para começar!

Criando a estrutura da API

from flask import Flask

app = Flask(__name__)

@app.route("/")
def hello():
    return "Hello, World!"

if __name__ == "__main__":
    app.run(debug=True)

python app.py

Parabéns, sua primeira API com Flask já está rodando!

Construindo um CRUD completo

Implementando o CREATE

from flask import request, jsonify

tasks = []  # Lista para armazenar as tarefas
task_id_control = 1  # Controlador de IDs para garantir unicidade

@app.route("/tasks", methods=["POST"])
def create_task():
    global task_id_control
    data = request.get_json()  # Pega os dados enviados no corpo da requisição
    new_task = {
        "id": task_id_control,
        "title": data.get("title"),  # Obtém o título enviado
        "description": data.get("description", ""),  # Descrição opcional
        "completed": False  # Define que a tarefa começa como incompleta
    }
    tasks.append(new_task)  # Adiciona a nova tarefa à lista
    task_id_control += 1  # Incrementa o ID para a próxima tarefa
    return jsonify({"message": "Tarefa criada com sucesso!", "task": new_task}), 201

Testando o CREATE

1. Configure uma requisição POST para o endpoint (rota) /tasks.

2. Envie o seguinte JSON no corpo da requisição:

{
  "title": "Aprender Flask",
  "description": "Estudar a criação de APIs"
}

{
  "message": "Tarefa criada com sucesso!",
  "task": {
    "id": 1,
    "title": "Aprender Flask",
    "description": "Estudar a criação de APIs",
    "completed": false}
}

Pronto! Você acabou de criar seu primeiro registro no sistema.

Implementando o READ

@app.route("/tasks", methods=["GET"])
def get_tasks():
    return jsonify({"tasks": tasks, "total": len(tasks)})

@app.route("/tasks/<int:task_id>", methods=["GET"])
def get_task(task_id):
    # Procura a tarefa pelo ID
    task = next((t for t in tasks if t["id"] == task_id), None)
    if not task:
        return jsonify({"message": "Tarefa não encontrada"}), 404
    return jsonify(task)

Testando o READ

• Para listar todas as tarefas, configure uma requisição GET para /tasks.

• Para buscar uma tarefa específica, use GET com /tasks/<ID>. Por exemplo, /tasks/1 retornará:

{
  "id": 1,
  "title": "Aprender Flask",
  "description": "Estudar a criação de APIs",
  "completed": false
}

{
  "message": "Tarefa não encontrada"
}

Implementando o UPDATE

@app.route("/tasks/<int:task_id>", methods=["PUT"])
def update_task(task_id):
    task = next((t for t in tasks if t["id"] == task_id), None)
    if not task:
        return jsonify({"message": "Tarefa não encontrada"}), 404

    data = request.get_json()
    # Atualiza os campos da tarefa com os dados enviados
    task["title"] = data.get("title", task["title"])
    task["description"] = data.get("description", task["description"])
    task["completed"] = data.get("completed", task["completed"])
    return jsonify({"message": "Tarefa atualizada com sucesso!", "task": task})

Testando o UPDATE

• Configure uma requisição PUT para /tasks/<ID>.

• Envie o seguinte JSON no corpo da requisição:

{
  "title": "Aprender Flask e APIs",
  "description": "Aprofundar nos conceitos",
  "completed": true
}

{
  "message": "Tarefa atualizada com sucesso!",
  "task": {
    "id": 1,
    "title": "Aprender Flask e APIs",
    "description": "Aprofundar nos conceitos",
    "completed": true}
}

Implementando o DELETE

@app.route("/tasks/<int:task_id>", methods=["DELETE"])
def delete_task(task_id):
    global tasks
    task = next((t for t in tasks if t["id"] == task_id), None)
    if not task:
        return jsonify({"message": "Tarefa não encontrada"}), 404
    tasks = [t for t in tasks if t["id"] != task_id]
    return jsonify({"message": "Tarefa deletada com sucesso!"})

Testando o DELETE

• Configure uma requisição DELETE para /tasks/<ID>.

• Após enviar, a resposta será:

{
  "message": "Tarefa deletada com sucesso!"
}

// Caso o ID não exista, a resposta será:

{
  "message": "Tarefa não encontrada"
}

Você acabou de criar um CRUD completo usando Flask! Que tal explorar mais sobre APIs REST, segurança ou até integrar sua API com um front-end? As possibilidades são infinitas, e você já deu o primeiro passo para se tornar um mestre em desenvolvimento de APIs.

Alternativas para testar sua API

Conheça o Thunder Client

Como usar o Thunder Client:

### Como usar o Thunder Client:

1. Instale a extensão **Thunder Client** no marketplace do VS Code.
2. Abra o painel do Thunder Client clicando no ícone correspondente na barra lateral.
3. Clique em **"New Request"** para criar uma nova requisição.
4. Selecione o método **POST**, insira a URL `http://localhost:5000/tasks` e, na aba **Body**, escolha o tipo **JSON**.
5. Insira o seguinte conteúdo no corpo da requisição:

    ```json
    {
      "title": "Aprender Flask",
      "description": "Estudar a criação de APIs"
    }
    ```

6. Clique em **Send** e veja a resposta diretamente no editor.

O Thunder Client é leve, fácil de usar e permite salvar suas requisições no repositório Git, facilitando a colaboração em equipe.

Testando APIs diretamente no terminal

Como Usar o HTTPie:

1. Instale o HTTPie no terminal com:

pip install httpie

2. Envie uma requisição para testar seu endpoint CREATE:

http POST http://localhost:5000/tasks title="Aprender Flask" description="Estudar a criação de APIs"

3. Veja a resposta estruturada diretamente no terminal.

O HTTPie é uma solução perfeita para quem gosta de trabalhar no terminal, mantendo o foco no código e economizando recursos do sistema.

Outras ferramentas e alternativas

• Rest Client Extension: Permite testar APIs diretamente no VSCode em um formato visual e salvar as requisições no seu projeto.

• Hoppscotch: Uma alternativa online para o Postman, ideal para testes rápidos.

📄

Se você quer ver essas ferramentas em ação e aprender mais sobre como utilizá-las, confira o vídeo abaixo. Ele apresenta as vantagens de cada uma e mostra como usá-las para otimizar seus testes:

Dicas de boas práticas com Flask

Validação de dados

from flask import request, jsonify

@app.route("/tasks", methods=["POST"])
def create_task():
    data = request.get_json()
    if not data.get("title"):
        return jsonify({"error": "O campo 'title' é obrigatório!"}), 400
    # Continuação do código...

2. Documentação

• Swagger: Crie uma interface visual para sua API com descrições detalhadas.

• Postman: Além de testar endpoints, documente e exporte coleções para outros desenvolvedores.

📽️

Ambos os vídeos mostram como elevar a qualidade da sua documentação com exemplos práticos.

3. Persistência de dados

• SQLite: Leve e ideal para aplicações pequenas ou aprendizado.

• PostgreSQL: Uma solução mais avançada e poderosa para projetos maiores.

• SQLAlchemy: Um ORM (Object-Relational Mapper) para facilitar a interação com bancos de dados no Flask.

from flask_sqlalchemy import SQLAlchemy

app.config['SQLALCHEMY_DATABASE_URI'] = 'sqlite:///tasks.db'
db = SQLAlchemy(app)

class Task(db.Model):
    id = db.Column(db.Integer, primary_key=True)
    title = db.Column(db.String(80), nullable=False)
    description = db.Column(db.String(200), nullable=True)
    completed = db.Column(db.Boolean, default=False)

Próximos passos: levando sua API para o próximo nível

Autenticação e segurança

from flask_jwt_extended import JWTManager

app.config['JWT_SECRET_KEY'] = 'sua_chave_secreta'
jwt = JWTManager(app)

Deploy: torne sua API pública

• Heroku: Simples e gratuito para começar.

• AWS: Para projetos de maior escala.

• Render: Fácil de usar e com boas opções para aplicações Flask.

Com isso, sua API estará disponível para qualquer usuário ou aplicação que precise dela.

Testes automatizados

def test_create_task(client):
    response = client.post('/tasks', json={"title": "Test Task"})
    assert response.status_code == 201
    assert response.get_json()["task"]["title"] == "Test Task"

Conclusão

Aprofunde-se e vá além!