<\> Casa do Dev
Notícias abrir
Ferramentas abrir
Vagas abrir
Aprender abrir
Comunidade abrir
Guia de Compras abrir

Como validar dados recebidos em uma api: guia completo com Node.js e python

DA

8 min

Como validar dados recebidos em uma api: guia completo com Node.js e python

Guia passo a passo para validar payloads de API usando Joi (Node.js) e Pydantic (Python), com exemplos de código prontos para rodar e boas práticas de segurança.

Neste artigo

O que e validacao de dados em API e por que e essencial?

Validar dados recebidos em uma API é a primeiro linha de defesa contra entradas malformadas ou maliciosas. Quando não filtramos o payload, abrimos brechas para injeção de dados, corrupçao de banco e comportamento inesperado do sistema. Um schema bem definido não garante apenas que o dado tem o tipo certo; ele impede que campos inesperados cheguem ao seu business logic. Neste tutorial, você veré como aplicar essa proteção em Node.js e Python, duas das pilhas mais usadas na indústria.

Prerequisitos e configuracao do ambiente

Para seguir os exemplos você precisará de Node.js v18+ e Python 3.10+. No Node, instalaremos o Joi via npm. No Python, usaremos Pydantic v2. Certifique-se de ter o ambiente virtual ativado no Python e o npm disponível no path do sistema.

AspectoDetalhe
Ambiente NodeNode.js v18+, npm v9+
Ambiente PythonPython 3.10+, pip ativo
Biblioteca NodeJoi (versão mais recente)
Biblioteca PythonPydantic v2.5+

Validando payloads com Joi em Node.js

O Joi é a biblioteca mais popular para validao de schemas em JavaScript. O padrão é definir o schema e passar o req.body na função validate(). Se falhar, o Joi retorna os detalhes do erro prontos para enviar ao cliente com status 400.

// index.js - Exemplos Joi
const Joi = require('joi');

const schema = Joi.object({
  nome: Joi.string().min(3).required(),
  idade: Joi.number().integer().min(18).max(99).required(),
  email: Joi.string().email({ minDomainSegments: 2 }).required()
});

const dados = { nome: 'Ana', idade: 25, email: 'ana@teste.com' };

const { error, value } = schema.validate(dados);

if (error) {
  console.error('Erro de validação:', error.details.map(d => d.message));
  process.exit(1);
}

console.log('Dados validados:', value);
// Saída: Dados validados: { nome: 'Ana', idade: 25, email: 'ana@teste.com' }

Note que o Joi já normaliza os tipos: se você enviar a idade como string "25", ele converte para o numero 25 automaticamente. Isso evita muitos bugs de comparação posterior.

Curso analista ciberseguranca junior cisco

Atenção:O Joi não valida dados aninhados automaticamente. Se seu payload tiver endereços completos com street, city e zip, cada nivel deve ter seu propio schema ou usar Joi.object().keys() aninhados. Misturar schemas soltos pode gerar validações silenciosas.

Validando payloads com Pydantic em Python

No ecossistema Python, o Pydantic v2 eleva a validação a outro patamar, gerando também modelos de dados tipados. A criação de um BaseModel já garante que o campo exista e que o tipo esteja correto. Ele é especialmente útil para APIs FastAPI e Django REST Framework.

# validacao.py - Exemplos Pydantic v2
from pydantic import BaseModel, Field, ValidationError

class Usuario(BaseModel):
    nome: str = Field(min_length=3)
    idade: int = Field(ge=18, le=99)
    email: str = Field(pattern=r'^.+@.+\..+$')

try:
    usuario = Usuario(nome='Joao', idade=30, email='joao@email.com')
    print('Objeto criado:', usuario)
    print('Email validado:', usuario.email)
except ValidationError as e:
    print('Erros de validacao:', e.errors())

O Pydantic já converte tipos automaticamente. Se você passar idade como string "30", ele transforma em int. O acesso a usuario.email já retorna o valor já limpo, pronto para ser usado em queries ou serializacao.

Cursos google ciee gratuitos certificado

Info:Em ambientes de produção com FastAPI, o Pydantic já roda automaticamente nos endpoints, eliminando a necessidade de validar manualmente o request body em cada rota.

Integração com OpenAPI e documentação automática

Ambas as bibliotecas geram schemas que podem ser exportados para OpenAPI. No Node com Joi, você pode usar o joi-to-openapi para gerar o contrato automático. No Python, o Pydantic já emite metadados que o FastAPI usa para popular a docs interativa em /docs. Isso significa que o desenvolvedor que consumir sua API verá imediatamente quais campos são obrigatórios e quais os tipos esperados, sem precisar ler o código fonte.

// Node: exemplo de exportacao simplificada
const joiToOpenApi = require('joi-to-openapi');
const schema = Joi.object({ name: Joi.string().required() });
const openApiDoc = joiToOpenApi.convert(schema);
console.log(openApiDoc);

# Python: FastAPI já usa o schema Pydantic automaticamente
from fastapi import FastAPI
from pydantic import BaseModel

app = FastAPI()

class Item(BaseModel):
    name: str
    price: float

@app.post('/items/')
async def create_item(item: Item):
    return {'item_received': item}

Isso reduz consideravelmente o trabalho de manutenção de documentação e garante que o contrato de entrada esteja sempre sincronizado com o código.

Databricks cursos gratuitos portugues

Erros comuns e como evitamos

  • Tipos inconsistentes: Enviar idade como string: both Joi e Pydantic convertem, mas valide o dominio do dado (idade deve ser int no banco).
  • Campos opcionais mal tratados: Usar .optional() no Joi ou Optional[str] no Pydantic quando o campo pode vir nulo, mas não pode ser undefined de forma inesperada.
  • Regex fraca no email: O pattern do Pydantic: teste com emails inusitados como user@sub.domain.co.uk para garantir que o regex aceita.

Testes automatizados com validação de dados

Validar em produção é importante, mas testar a validação garante que as regras não foram quebradas em uma nova versão. No Node, use o supertest com o joi expectations. No Python, o teste simplesmente envia o payload e espera que o Pydantic levante o ValidationError ou retorne o modelo validado.

# Node com supertest e Joi
const request = require('supertest');
const app = require('./app');
const { expect } = require('chai');

it('deve validar e rejeitar payload invalido', async () => {
  const res = await request(app).post('/usuarios').send({ nome: 'A', idade: 'nao e numero' });
  expect(res.status).to.equal(400);
});

# Python com Pytest
import pytest
from validacao import Usuario

def test_usuario_invalido():
    with pytest.raises(ValidationError):
        Usuario(nome='X', idade='trinta')

Esses testes garantem que, se alguém mudar o schema de validacao, os testes quebram e voc&ecacute; percebe a mudana antes de ir para produção.

Boas práticas e dicas de produtividade

  1. Valide o mínimo necessario: Não valide tudo no frontend. O backend é a única fonte de verdade. Campos que não afetam seguranca podem ter validacao mais leve.
  2. Use schemas centrais: Defina o schema em um arquivo separado e exporte para controladores/routes. Evite duplicar a estrutura em varios lugares.
  3. Trate erros padronizados: Retorne sempre um objeto de erro com codigo e mensagem legivel, ex: { code: 'VALIDATION_ERROR', message: 'Nome muito curto' }.
  4. NÃo use validation para logica de negocio: Validar que o email tem formato de email é responsabilidade da valida&ccao. Validar se o email já existe no banco é negocio. Mantenha os separados.

Perguntas Frequentes

Como validar payload JSON em API Node.js usando Joi?

Crie um schema com Joi.object(), chame schema.validate(req.body) e verifique o retorno error. Se houver erro, envie status 400 com as mensagens detalhadas do error.details. O Joi converte tipos automaticamente (string para number) e suporta rules como .min(), .max(), .required().

Curso gratuito analise de dados dashboards google looker studio senai

Quais as melhores práticas de validação de entrada em APIs Python?

Use Pydantic para definir schemas de dados que também servem como modelos. Aproveite a integração nativa com FastAPI para validacao automtica nos endpoints. Valide tipos primitivos com restricoes (ge, le) e use regex apenas quando necessario, testando casos de borda como emails com subdomínios complexos.

Como implementar validação de schema OpenAPI em Django REST Framework?

O Django REST Framework não tem valida&ccao de schema built-in como o FastAPI, mas você pode usar a biblioteca drf-spectacular para gerar o OpenAPI a partir dos serializers. A valida&ccão de entrada continua sendo feita nos serializers (baseados em Django Forms/ModelForms), que podem ser configurados para usar validadores customizados ou integrar bibliotecas externas como o Marshmallow.

Como testar automaticamente a resposta de uma API com validação de dados?

Use bibliotecas de teste como supertest (Node) ou pytest (Python). Envie payloads inválidos e verify que o status 400 é retornado. Para payloads válidos, verifique se o objeto retornado já passou pela valida&ccedel;ao e possui os campos esperados com os tipos corretos.

Curso gratuito microsoft analise de dados power bi certificado

Quais bibliotecas usar para validar dados de API em Java Spring Boot?

O Spring Boot usa annotations nativas como @Valid e @Size, @Min, @Max sobre os campos do DTO (Data Transfer Object). A biblioteca Hibernate Validator é a implementacao por traz. Funciona de forma similar ao Pydantic/Joi: define regras por campo e o framework retorna erros 400 automaticamente quando a anotação falha.

Como lidar com mensagens de erro de validação em endpoints REST?

Padronize o formato de erro em sua API. Em vez de expor as mensagens brutas do validador, mapeie para um objeto estruturado como { campo: mensagem amigavel }. Em Node com Joi, use error.details.map(d => d.message) e transforme em sua estrutura de resposta. Em Python Pydantic, use e.errors() e formate conforme necessidade, mas sempre mantenha o campo identificado para que o consumidor saiba onde corrigir.

N/A

Explorar cursos de dadosLink interno para expansão de carreira

O que você achou deste artigo?

Responda a Pergunta do Dia Teste seu conhecimento e mantenha sua streak. Crie seu Dev Card público Perfil dev compartilhável em um único link.

Depois dessa formação...

Veja vagas em tecnologia →

Vagas relacionadas

Ver todas as vagas →
DA

Escrito por

Dagmar

Publicado em

Ver perfil do autor

COMPARTILHAR