GET-verzoeken

Waarom hebben we GET blocks nodig, en hoe werken ze?

Wanneer u een frontend ontwikkelt, zult u onvermijdelijk verschillende BP's moeten uitvoeren op de backend. Om een BP uit te voeren, moet je zijn eindpunt aanroepen. Hiervoor maakt AppMaster voor elk eindpunt een Server Request blok aan. Deze blokken hebben dezelfde in- en uitgangsvelden als het bijbehorende endpoint en dienen als een manier om het te starten.

GET blokken moeten, volgens de principes van de REST API, gegevens ophalen. Meestal halen GET-blokken gegevens op uit het model in de database (alle, of volgens bepaalde criteria).

Zoals alle Server Request blokken is elk GET blok gebonden aan zijn eigen endpoint. De Url van het eindpunt wordt weergegeven in de naam van de blokken.

Onthoud dat AppMaster automatisch basis eindpunten genereert. Maar u kunt ook uw BP's en endpoints daarvoor aanmaken, en dus ook uw Server Request blokken.

Input- en outputvelden van de GET block

Input

• Endpoint ID - bepaalt welk eindpunt het blok moet benaderen. Dit veld wordt automatisch ingesteld;
• _offset - maakt het mogelijk te specificeren van welk record het blok informatie zal ontvangen; integer formaat;
• _limit - het aantal records dat het blok laadt. De default is 25, het maximum per keer is 500; integer format;
• _sort_order - twee waarden zijn geschikt voor dit veld: asc - directe sorteervolgorde en desc - omgekeerde volgorde; string formaat;
• _sort_by - bepaalt op welk veld van het datamodel de lijst wordt gesorteerd; stringformaat;
• Ids - lijst van record-id's. Maakt het mogelijk records op te vragen per specifiek id; matrix integer formaat;
• _search - zoekt naar een bepaalde waarde in het datamodel; string formaat;
• _search_exact - schakelt zoeken naar exacte overeenkomsten in of uit; booleaans formaat;
• _ search_in - zoeken op specifieke velden; array string formaat.

Laten we de velden die bij de zoekopdracht horen eens nader bekijken.

_search - zoekt naar overeenkomsten in het gehele gegevensmodel en vindt deze ongeacht het veld waarin de waarde zich bevindt.

Laten we bijvoorbeeld het veld _search instellen op John. Als in het gegevensmodel voor één record de waarde van het veld naam John is, en voor het andere de waarde van het veld e-mail [email protected], dan zal de zoekopdracht beide records vinden.

_search_exact - Dit veld inschakelen betekent dat de resultaten records zullen bevatten die volledig overeenkomen met de query.

_search_in - hier kunt u de velden instellen waarin gezocht moet worden. Als we bijvoorbeeld alleen op namen willen zoeken en de gevallen waarin de naam deel uitmaakt van de e-mail niet in aanmerking willen nemen, kunnen we _search_in gebruiken en alleen op het veld naam zoeken.

Gegevensmodelvelden zoeken

Deze velden worden gebruikt om in het datamodel te zoeken. Het belangrijkste verschil met zoekvelden is dat ze verschillende waarden kunnen aannemen, in tegenstelling tot zoeken, dat alleen string-formaten accepteert.

Uitvoer

• _success - zoekresultaten; booleaans formaat;
• _httpcode - request response code; integer formaat;
• _error - fout tekst; string formaat;
• Data - ontvangen records; array model formaat;
• Count - het aantal ontvangen records; integer formaat.

Het veld _with veld

Deze verschijnt in die blokken waar het verzoek naar gerelateerde datamodellen gaat. Hiermee kunt u gegevens halen uit het gegevensmodel waarnaar het verzoek is gedaan en uit de gegevensmodellen die ermee verbonden zijn.

Laten we eens kijken naar het _with veld met behulp van een voorbeeldtoepassing waarin een lijst van boeken en hun categorieën wordt opgeslagen.

Maak twee gegevensmodellen: book en category. In de book voegen we het book_name veld, en in de category voegen we het category_name veld toe.

Maak een verbinding tussen hen. We trekken het van categorie naar boek en stellen het relatietype in op has_many omdat één categorie naar verschillende boeken kan verwijzen.

Stel onder het tabblad webtoepassing het laden van gegevens in de tabellen boek en categorie in en voeg records toe aan deze tabellen. Gekoppelde gegevens worden momenteel niet weergegeven in tabellen. Om dit op te lossen is het _with veld nodig.

Stel dit veld in de Get block voor elke tabel.

Laten we nu onze applicatie openen en ervoor zorgen dat de query wordt uitgevoerd en dat de juiste gegevens in de tabel verschijnen.