Busca - @Search

[botelhojp]

Mecanismo de Busca na camada Rest - implementado no módulo CRUD.

Como desenvolver desejo funcionalidades para facilitar a implementação de buscas em recursos que utilizam o CRUD.

Annotation @Search

• Pode ser utilizada apenas em escopo de métodos que retornem a interface Result;

Essa annotation é responsável por:

• [x] filtro (busca igual)
  • [X] filtro de primeiro nível
  • [x] filtro de segundo nível
• [x] ~pesquisa (likes)~ - Cancelado nesta release
• [x] ordenação
• [x] ~update (fulll, parcial)~ - Movido para issue #37
• [X] fields (retorno dos campos)
  • [X] fields de primeiro nível
  • [X] fields de segundo nível
• [x] filtro de campos de entrada e retorno baseado no atributo fields do @Search

Detalhamento

• Usado na camada Rest @Search(fields={"nome", "cpf"})
• O atributo fields é obrigatório
• No AbstractREST, não terá @Search e nem a listagem visando não expor dados sensíveis
• O método find deve ser implementado na camada REST da aplicação.
• É possível filtrar e retornar apenas campos que estão no atributo fields

Exemplos de requisições de busca

• "api/recurso?fields=" - campos de retorno
• "api/recurso?sort=&order=" - ordenação
• "api/recurso?salario=1000&nome=maria,jose,odair"
• filtro com campos sensíveis (salário)
  • o retorno deve ser "bad request"
• ~"api/recurso?range="~ - a paginação é tratada na issue #53
• "api/recurso?fields=salario,endereco(id,logradouro)"