Testování výkonného serveru 4D REST pomocí aplikace Postman

4D poskytuje výkonný server REST, který umožňuje přímý přístup k datům uloženým v databázích 4D. To umožňuje například vytvořit rozhraní API, které lze použít s moderní technologií front-endu(např. , Angular, React atd.). V tomto příspěvku na blogu vám poskytneme první seznámení s robustním serverem 4D REST. Uvidíte, jak jej nakonfigurovat a otestovat operace vytváření, načítání, aktualizace a mazání (CRUD) pomocí nástroje pro testování API, Postman.

Konfigurace serveru REST

POZNÁMKA: Pokud již víte, jak nakonfigurovat server REST a databázi 4D, můžete následující dvě části přeskočit.

Chcete-li využívat server 4D REST, musíte jej nejprve nakonfigurovat (stačí jediné kliknutí pro zprovoznění). Stačí zaškrtnout možnost“ Expose as REST server“ na stránce „Web/REST resource“ v nastavení databáze, aby se zpracovávaly požadavky REST:

Vytvoření a konfigurace databáze 4D

• Tento krok předpokládá, že jste již vytvořili databázi a aktivovali Rest server. Přejděte do své struktury a vytvořte novou tabulku [Tasks] se dvěma atributy: Úkoly: Název (Alpha) a Dokončit (Boolean). Ve výchozím nastavení jsou všechny tabulky vystaveny v režimu REST:

Důležité : názvy tabulek a polí musí být v souladu se standardem JSON (bez diakritických znaků a mezer).

• Nyní se pusťte do vytváření vstupních a výstupních formulářů. Do tabulky Tasks (Úkoly) zadejte několik úkolů.

• V nabídce Spustit vyberte možnost Spustit webový server (pokud ještě není spuštěn) a poté vyberte možnost Testovat webový server.
• Gratuluji! Nyní můžete číst a upravovat data v rámci 4D pouze pomocí požadavků REST.
  Jak to poznáte? Snadno, otevřete webový prohlížeč a za ADDRESS:PORT vložte„/rest“. (Všechny požadavky 4D REST URL začínají /rest).
  Chcete-li například získat všechny entity datové třídy [Tasks], můžete postupovat takto:

Testování rozhraní API pomocí aplikace Postman

Úžasné na serveru 4D REST je, že rozhraní API poskytuje operace CRUD(a další!) … připravené k použití! K vytvoření, čtení, aktualizaci nebo odstranění entity není potřeba ani řádek kódu. Vše je připraveno za vás. Jak všichni víme, CRUD je nejdůležitější skupinou databázových operací, protože jsou to hlavní funkce, které uživatelé potřebují k vytváření a správě dat.

K otestování tohoto úžasného rozhraní API použijeme Postman (vynikající nástroj pro testování rozhraní RESTful API). Postman nabízí elegantní uživatelské rozhraní pro zadávání požadavků HTML, jako jsou GET, POST, PUT/UPDATE, DELETE a různé další metody požadavků.

Poznámka: Používání nástroje Postman je jednoduché, nicméně pokud potřebujete pomoci se začátkem, podívejte se na toto video.

ZÍSKÁNÍ seznamu úloh

Po stažení nástroje Postman jej spusťte a vytvoříme naše různé požadavky. Začneme nejzřejmějším požadavkem: Získání seznamu úkolů (z naší tabulky [Úkoly]). Jak již bylo uvedeno dříve, pro získání všech entit datové třídy [Tasks] nezapomeňte za ADDRESS:PORT vložit /rest/NameOfTheDataclass.

1. Ze seznamu metod vyberte metodu GET
2. Zkopírujte adresu URL
3. Klikněte na tlačítko odeslat
4. Voilà:

Jak vidíte, k získání seznamu úkolů není potřeba ani řádek kódu!

Vytvoření nové úlohy

Do naší datové třídy můžeme také přidat nový úkol … také bez kódu. Rozhraní API je již připraveno za vás!

Chcete-li vytvořit novou entitu, tato adresa URL vyvolá požadavek na nový úkol: ADDRESS:PORT/rest/NameOfTheDataclass/?$method=update. Za tímto účelem musíme do aplikace odeslat požadavek JSON. Pokud se podíváte na výsledky požadavku GET, získáte představu o klíčích potřebných k vytvoření nové úlohy. Podle této logiky tedy budeme potřebovat pouze název a kompletní pole; o zbytek (klíč, časové značky, razítko a ID) se postará 4D.

1. Změňte metodu na POST
2. Vložte adresu URL
3. Klikněte na tlačítko odeslat
4. Přidejte novou úlohu
5. Ujistěte se, že success = true!

Vraťte se na první kartu (metoda GET), klikněte na tlačítko Odeslat a zkontrolujte, zda byla úloha přidána. Můžete také přejít do výstupního formuláře 4D a zjistit, zda byla nová úloha přidána!

Aktualizace úlohy

Pro aktualizaci entity použijeme stejnou metodu, jakou jsme použili při jejím vytváření. $method=update umožňuje aktualizovat jednu nebo více entit v jednom POSTu. K tomu je třeba předat v objektu parametry __KEY a __STAMP spolu s případnými upravenými atributy.

V našem příkladu jsme dokončili čtení jednoho z Hemingwayových nejtrvalejších děl: Stařec a moře. Proto musíme změnit stav dokončení úlohy na true. Snadno:

Odstranění úlohy

Odstranění entity je také jednoduché. V našem příkladu chceme odstranit úlohu s ID = 3 (nazvanou „test“). Žádný problém! Zavoláme metodu delete a zadáme ji pomocí jejího ID: dataclass(ID)?$method=delete.

Vraťte se do databáze 4D a ověřte, zda byla entita smazána! Je pryč, že ano?

Co bude následovat

Jak vidíte, server 4D REST je mocný. Poskytuje bohaté API nad rámec toho, co jsme si právě ukázali. V krátké době toho lze udělat mnohem více. Podívejte se na podrobnou dokumentaci. V příštích příspěvcích na blogu se s vámi podělím o tip na autentizaci a poté o kompletní front-endovou aplikaci napsanou v ReactJS s REST pro webový přístup k databázi 4D.