Filtros

Em recursos de listagem da Kruzer, todas as requisições suportam filtros completos para todo o dicionário de dados das entidades. Essa funcionalidade permite que as implementações recuperem dados específicos com base em suas necessidades, proporcionando um controle granular sobre as respostas da API.

Exemplos de uso:

• Filtragem Simples

  Você pode filtrar entidades com base em um único critério, como no exemplo abaixo, que filtra produtos que estão habilitados:

    GET /products?enabled=true
  

  Neste caso, a requisição retornará apenas os produtos que possuem a propriedade enabled definida como true.

• Filtragem com Múltiplos Valores

  A Kruzer também oferece suporte para filtrar com múltiplos valores em um único campo, permitindo uma maior flexibilidade. No exemplo abaixo, filtramos produtos que possuem qualquer uma das tags minor ou major:

    GET /products?tags=minor,major
  

  Esse tipo de filtragem é particularmente útil em cenários onde um campo pode assumir múltiplos valores e você deseja recuperar todos os registros que correspondam a qualquer um desses valores.

• Filtragem de Campos Numéricos e de Datas

  Para campos numéricos e de datas, a Kruzer oferece sufixos especiais que permitem comparar valores maiores ou menores do que o especificado, permitindo uma filtragem mais refinada. Os sufixos _gt, _gte, _lt e _lte podem ser aplicados aos nomes das propriedades para realizar essas comparações:

  • _gt (greater than): Filtra valores maiores que o especificado.
  • _gte (greater than or equal): Filtra valores maiores ou iguais ao especificado.
  • _lt (less than): Filtra valores menores que o especificado.
  • _lte (less than or equal): Filtra valores menores ou iguais ao especificado.

  Exemplo com o campo updated_at (data de atualização):

  • Filtrar registros atualizados após uma data específica:

      GET /products?updated_at_gt=2024-01-01T00:00:00Z
    

    Este exemplo retorna todos os produtos atualizados após 1º de janeiro de 2024.

  • Filtrar registros atualizados em ou após uma data específica:

      GET /products?updated_at_gte=2024-01-01T00:00:00Z
    

    Este exemplo retorna todos os produtos atualizados em ou após 1º de janeiro de 2024.

  • Filtrar registros atualizados antes de uma data específica:

      GET /products?updated_at_lt=2024-01-01T00:00:00Z
    

    Este exemplo retorna todos os produtos atualizados antes de 1º de janeiro de 2024.

  • Filtrar registros atualizados em ou antes de uma data específica:

      GET /products?updated_at_lte=2024-01-01T00:00:00Z
    

    Este exemplo retorna todos os produtos atualizados em ou antes de 1º de janeiro de 2024.

Esses exemplos mostram como a Kruzer facilita a criação de filtros complexos e personalizados, adaptados às necessidades específicas de cada aplicação, garantindo que os dados mais relevantes sejam facilmente acessíveis.