Porque precisamos de GET blocks, e como é que eles funcionam?
Quando se desenvolve um frontend, será inevitavelmente necessário correr diferentes BPs no backend. Para executar um BP, é necessário chamar o seu ponto final. Para o fazer, o AppMaster cria um bloco de Pedido de Servidor para cada endpoint. Estes blocos têm os mesmos campos de entrada e saída que o endpoint associado e servem como uma forma de o iniciar.
Os blocosGET , de acordo com os princípios da API REST, devem recuperar alguns dados. Na maioria das vezes, os blocos GET recuperam dados do modelo na base de dados (todos, ou por certos critérios).
Como todos os blocos de Pedido de Servidor, cada bloco GET está vinculado ao seu próprio ponto final. A Url do endpoint é exibida no nome dos blocos.
Tenha em mente que o AppMaster gera endpoints básicos automaticamente. Mas também pode criar os seus BPs e endpoints para eles, e consequentemente os seus blocos de Pedido de Servidor.
Campos de entrada e saída do GET block
Entrada
- Endpoint ID - determina a que ponto final o bloco deve aceder. Este campo é definido automaticamente;
- _offset - permite especificar de que registo o bloco irá receber informação; formato inteiro;
- _limit - o número de registos que o bloco carrega. O padrão é 25, o máximo de cada vez é 500; formato inteiro;
- _sort_order - dois valores são adequados para este campo: asc - ordem de ordenação directa e desc - ordem inversa; formato de string;
- _sort_by - define por qual campo do modelo de dados a lista será ordenada; formato de cadeia de caracteres;
- Ids - lista de identificações dos registos. Permite obter registos por id específico; formato inteiro de matriz;
- _search - procura de um dado valor no modelo de dados; formato de cadeia de caracteres;
- _search_exact - permite/desactiva a pesquisa de correspondência exacta; formato booleano;
- _ search_in - pesquisa por campos específicos; formato de cordas de matriz.
Vamos analisar mais de perto os campos associados à pesquisa.
_search - procura correspondências em todo o modelo de dados e irá encontrá-las independentemente do campo em que o valor está localizado.
Por exemplo, vamos definir o campo _pesquisa para John. Se no modelo de dados, para um registo, o valor do campo de nome é João, e para o outro, o valor do campo de e-mail é [email protected], então a pesquisa encontrará ambos estes registos.
_search_exact - A activação deste campo significa que os resultados incluirão registos que coincidam completamente com a consulta.
Pedido | _search_exact | Resultado |
John | False | John, Johny, [email protected] |
John | True | John |
_search_in - aqui, pode definir os campos onde a pesquisa deve ser efectuada. Por exemplo, se quisermos pesquisar apenas por nomes e não considerar casos em que o nome é a parte do e-mail, podemos utilizar _search_in e pesquisar apenas pelo campo do nome.
Pesquisar campos de modelos de dados
Estes campos são utilizados para pesquisar pelo modelo de dados. A principal diferença entre eles e os campos de pesquisa é que podem assumir valores diferentes, ao contrário da pesquisa, que só aceita o formato de cordas.
Saída
- _success - resultados da pesquisa; formato booleano;
- _httpcode - código de resposta de pedido; formato inteiro;
- _error - texto de erro; formato de cadeia de caracteres;
- Data - registos recebidos; formato do modelo de matriz;
- Count - o número de entradas recebidas; formato inteiro.
O _with campo
Aparece nos blocos em que o pedido vai para modelos de dados relacionados. Permite obter dados do modelo de dados ao qual o pedido é feito e dos modelos de dados a ele associados.
Vejamos o _with campo utilizando uma aplicação de exemplo que armazena uma lista de livros e as suas categorias.
Criar dois modelos de dados: book e category. No book acrescentamos o book_name e no campo, e no category acrescentamos o category_name campo.
Criar uma ligação entre eles. Vamos desenhá-la da categoria para o livro e definir o tipo de relação com has_many uma vez que uma categoria pode referir-se a diferentes livros.
Sob o separador da aplicação web, configurar o carregamento de dados nas tabelas de livros e categorias e adicionar registos a estas tabelas. Os dados ligados não são actualmente apresentados em tabelas. Para corrigir isto, o _with campo é necessário.
Instalar este campo no Get block para cada mesa.
Agora vamos abrir o nosso pedido e certificar-nos de que a consulta está a decorrer e que os dados correctos aparecem na tabela.
