Filtros paramétricos para APIs

Outra forma de filtrar uma API é através de filtros paramétricos por meio de chaves

Parâmetros

Parâmetros para filtrar APIs REST são informações enviadas na requisição (normalmente na URL) para que o servidor retorne apenas os dados que atendem a determinados critérios. Em vez de buscar todos os registros e filtrar depois, você já solicita exatamente o que precisa.

Query Parameters

São adicionados após o uso de interrogação ? na URL. Por exemplo:

<API> /usuarios?cidade=SãoPaulo <API> /pedidos?status=aprovado <API> /produtos?precoMin=100&precoMax=500

Aqui, você está dizendo para a API:

• Traga apenas usuários de São Paulo

• Traga apenas pedidos aprovados

• Traga produtos dentro de uma faixa de preço

Parâmetros estruturados

Algumas APIs permitem filtros mais complexos, como:

GET /usuarios?idade_gt=18 GET /pedidos?dataInicio=2024-01-01&dataFim=2024-12-31

Outras usam padrões específicos, como:

• filter=

• search=

• q=

Atenção: isso depende da arquitetura da API.

Path Parameters

Quando você quer um recurso específico. Por exemplo:

GET /usuarios/123 GET /pedidos/987

Aqui não é exatamente “filtro”, mas sim identificação direta de um recurso. Neste caso, selecionando um único usuário e um único pedido.

Exemplo prático