¿Por qué necesitamos GET blocks, y cómo funcionan?
Cuando desarrollas un frontend, inevitablemente necesitarás ejecutar diferentes BPs en el backend. Para ejecutar un BP, es necesario llamar a su punto final. Para ello, AppMaster crea un bloque de solicitud de servidor para cada punto final. Estos bloques tienen los mismos campos de entrada y salida que el endpoint asociado y sirven para iniciarlo.
Los bloquesGET , según los principios de la API REST, deben recuperar algunos datos. La mayoría de las veces, los bloques GET recuperan datos del modelo de la base de datos (todos, o por determinados criterios).
Como todos los bloques de solicitud de servidor, cada bloque GET está vinculado a su propio punto final. La Url del endpoint se muestra en el nombre de los bloques.
Tenga en cuenta que AppMaster genera automáticamente los endpoints básicos. Pero usted también puede crear sus BPs y endpoints para ellos, y consecuentemente sus bloques de Solicitud de Servidor.
Los campos de entrada y salida del bloque GET block
Entrada
- Endpoint ID - determina a qué punto final debe acceder el bloque. Este campo se establece automáticamente;
- _offset - permite especificar de qué registro recibirá información el bloque; formato entero;
- _limit - el número de registros que carga el bloque. El valor por defecto es 25, el máximo a la vez es 500; formato entero;
- _sort_order - dos valores son adecuados para este campo: asc - orden directo y desc - orden inverso; formato de cadena;
- _sort_by - define por qué campo del modelo de datos se ordenará la lista; formato de cadena;
- Ids - lista de ids de registros. Permite obtener registros por un id específico; formato de array de enteros;
- _search - buscar un valor determinado en el modelo de datos; formato de cadena;
- _search_exact - permite/desactiva la búsqueda de coincidencias exactas; formato booleano;
- _ search_in - buscar por campos específicos; formato de cadena de array.
Echemos un vistazo a los campos asociados a la búsqueda.
_search - busca coincidencias en todo el modelo de datos y las encontrará independientemente del campo en el que se encuentre el valor.
Por ejemplo, establezcamos el campo _search como Juan. Si en el modelo de datos, para un registro, el valor del campo nombre es Juan, y para el otro, el valor del campo email es [email protected], entonces la búsqueda encontrará ambos registros.
_search_exact - habilitar este campo significa que los resultados incluirán los registros que coincidan completamente con la consulta.
Solicitud | _search_exact | Resultado |
John | False | John, Johny, [email protected] |
John | True | John |
_search_in - aquí se pueden establecer los campos en los que se debe realizar la búsqueda. Por ejemplo, si queremos buscar sólo por nombres y no considerar los casos en los que el nombre forma parte del correo electrónico, podemos utilizar _search_in y buscar sólo por el campo nombre.
Campos del modelo de datos de búsqueda
Estos campos se utilizan para buscar por el modelo de datos. La principal diferencia entre ellos y los campos de búsqueda es que pueden tomar diferentes valores, a diferencia de la búsqueda, que sólo acepta el formato de cadena.
Salida
- _success - resultados de la búsqueda; formato booleano;
- _httpcode - código de respuesta de la solicitud; formato entero;
- _error - texto de error; formato de cadena;
- Data - registros recibidos; formato de modelo de array;
- Count - número de registros recibidos; formato entero.
El campo _with campo
Aparece en aquellos bloques en los que la petición va a modelos de datos relacionados. Permite obtener datos del modelo de datos al que se hace la petición y de los modelos de datos asociados a él.
Veamos el campo _with utilizando una aplicación de ejemplo que almacena una lista de libros y sus categorías.
Cree dos modelos de datos book y category. En el modelo book añadimos el campo book_name y en el campo category añadimos el campo category_name campo.
Creamos una relación entre ellos. Vamos a dibujarla desde la categoría al libro y establecemos el tipo de relación a has_many ya que una categoría puede referirse a diferentes libros.
En la pestaña de la aplicación web, configuremos la carga de datos en las tablas de libros y categorías y añadamos registros a estas tablas. Los datos vinculados no se muestran actualmente en las tablas. Para solucionar esto, se necesita el campo _with es necesario.
Configure este campo en el Get block para cada tabla.
Ahora abramos nuestra aplicación y comprobemos que la consulta se ejecuta y que los datos correctos aparecen en la tabla.
