Richieste GET

Perché abbiamo bisogno di GET blocks e come funzionano?

Quando si sviluppa un frontend, è inevitabile dover eseguire diversi BP sul backend. Per eseguire un BP, è necessario chiamare il suo endpoint. A tale scopo, AppMaster crea un blocco Server Request per ogni endpoint. Questi blocchi hanno gli stessi campi di input e output dell'endpoint associato e servono per avviarlo.

I blocchiGET , secondo i principi dell'API REST, devono recuperare alcuni dati. Il più delle volte, i blocchi GET recuperano dati dal modello nel database (tutti o in base a determinati criteri).

Come tutti i blocchi Server Request, ogni blocco GET è legato al proprio endpoint. L'URL dell'endpoint viene visualizzato nel nome del blocco.

Si tenga presente che AppMaster genera automaticamente gli endpoint di base. Tuttavia, è possibile creare i propri BP e i relativi endpoint e, di conseguenza, i blocchi Server Request.

I campi di ingresso e di uscita del blocco GET block

Ingresso

• Endpoint ID - determina l'endpoint a cui il blocco deve accedere. Questo campo viene impostato automaticamente;
• _offset - consente di specificare da quale record il blocco riceverà le informazioni; formato intero;
• _limit - il numero di record che il blocco carica. Il valore predefinito è 25, il massimo per volta è 500; formato intero;
• _sort_order - per questo campo sono adatti due valori: asc - ordine diretto e desc - ordine inverso; formato stringa;
• _sort_by - definisce in base a quale campo del modello di dati verrà ordinato l'elenco; formato stringa;
• Ids - elenco degli id dei record. Permette di ottenere i record in base a un id specifico; formato array di interi;
• _search - ricerca di un determinato valore nel modello di dati; formato stringa;
• _search_exact - abilita/disabilita la ricerca per corrispondenza esatta; formato booleano;
• _ search_in - ricerca per campi specifici; formato array di stringhe.

Diamo un'occhiata più da vicino ai campi associati alla ricerca.

_search - cerca le corrispondenze in tutto il modello di dati e le trova indipendentemente dal campo in cui si trova il valore.

Ad esempio, impostiamo il campo _search su John. Se nel modello dei dati, per un record, il valore del campo name è John e per l'altro, il valore del campo email è [email protected], la ricerca troverà entrambi i record.

_search_exact - L'abilitazione di questo campo significa che i risultati includeranno i record che corrispondono completamente alla query.

_search_in - Qui si possono impostare i campi in cui effettuare la ricerca. Ad esempio, se si vuole cercare solo per nome e non considerare i casi in cui il nome è parte dell'email, si può usare _search_in e cercare solo per il campo nome.

Campi del modello di dati di ricerca

Questi campi sono utilizzati per la ricerca in base al modello dei dati. La differenza principale tra questi e i campi di ricerca è che possono assumere valori diversi, a differenza di search, che accetta solo il formato stringa.

Uscita

• _success - risultati della ricerca; formato booleano;
• _httpcode - codice di risposta della richiesta; formato intero;
• _error - testo di errore; formato stringa;
• Data - record ricevuti; formato modello array;
• Count - numero di voci ricevute; formato intero.

Il campo _with campo

Appare nei blocchi in cui la richiesta va ai modelli di dati correlati. Permette di ottenere dati dal modello di dati a cui è stata fatta la richiesta e dai modelli di dati ad esso associati.

Vediamo il campo _with utilizzando un esempio di applicazione che memorizza un elenco di libri e le loro categorie.

Creare due modelli di dati: book e category. Nel modello book aggiungiamo il campo book_name e nel modello category si aggiunge il campo category_name campo.

Creiamo una relazione tra loro. Tracciamola dalla categoria al libro e impostiamo il tipo di relazione a has_many poiché una categoria può fare riferimento a diversi libri.

Nella scheda Applicazione web, impostare il caricamento dei dati nelle tabelle dei libri e delle categorie e aggiungere record a queste tabelle. Attualmente i dati collegati non vengono visualizzati nelle tabelle. Per risolvere questo problema, è necessario il campo _with è un campo necessario.

Impostare questo campo nella scheda Get block per ogni tabella.

Ora apriamo la nostra applicazione e verifichiamo che la query sia in esecuzione e che i dati giusti appaiano nella tabella.