uzel.JS je běh JavaScriptu, který staví na JavaScriptu V8 v prohlížeči Chrome. Node je určen k vytváření škálovatelných síťových aplikací. V tomto článku se zaměřujeme na vytvoření REST API pomocí uzlu.js. Budeme budovat jednoduchou kalkulační službu, která provede základní výpočty a vrátí zpět generované výstupy.
co je REST API?
Jednoduše RESTful API je aplikace, programátorské rozhraní (API), který používá žádost HTTP GET, POST, PUT, DELETE data. Také známý jako RESTful webové služby. REST znamená reprezentativní státní přenos, což je architektonický styl pro vývoj webových služeb.
co budeme stavět?
budeme vytvářet jednoduchou webovou službu, která provede některé výpočty a vrátí zpět hodnoty. Adresy URL požadavků a výstup budou vypadat takto.
Co potřebujeme
- pěkný malý editor kódu, jako je Visual Studio Code.
- uzel.JS nainstalován ve vašem systému.
- rámec služeb – v tomto článku používám hapi.js (vyslovováno jako Happy JS)
- aplikace jako POSTMAN (rozšíření aplikace chrome) pro testování naší služby.
jsem v macOS High Sierra verze 10.13.3. Příkazy shellu musí být podobné na jiných platformách.
začněme
kliknutím sem získáte úplný pracovní vzorek.
nejprve je třeba zkontrolovat verzi uzlu.js máš. Umožňuje otevřít terminál a zadejte následující příkaz pro kontrolu verze uzlu.js máš. Používám verzi 8.9.4
$ node --version
OK, nyní vytvořte adresář pro uložení kódu a přejděte do něj pomocí následujících příkazů shellu.
$ mkdir calc-service
$ cd calc-service
umožňuje vytvořit náš projekt.json soubor, zadáním tohoto příkazu.
$ npm init
odpovězte na otázky a váš projekt.soubor json by měl vypadat takto.
pěkné, nyní jsme vytvořili základnu našeho uzlu.služba js. Další věc, kterou musíme nainstalovat hapi.JS framework. hapi.js je bohatý rámec umožňuje vytvářet webové aplikace, stejně jako služby založené na uzlu.js.
umožňuje jít do terminálu a zadejte a zadejte následující příkaz.
$ npm install --save [email protected]
npm je správce balíčků, který umožňuje instalovat tisíce modulů pro práci s Node.js. Pokud se podíváte na výše uvedený příkaz, instruovali jsme npm k instalaci hapi verze 17. Také jsme požádali o aktualizaci balíčku.json soubor pomocí možnosti Uložit.
nyní by vaše struktura složek měla vypadat takto.
Jak vidíte hapi.JS závislost byla aktualizována v balíčku.json soubor, stejně jako požadované node_modules jsou aktualizovány.
umožňuje vytvořit server nyní
v tomto kroku budeme hledat vytvoření serveru, který bude poslouchat naše požadavky. V terminálu zadejte následující příkaz k vytvoření serveru.soubor js. To musí být v kořenovém adresáři, ve kterém se nacházíte. Nebo můžete použít nový soubor Na kartě levého podokna v kódu VS.
$ touch server.js
Umožňuje přidat následující kód v serveru.soubor js. Tento kód vytvoří kód, který bude poslouchat požadavky uživatelů na daném portu.
umožňuje zkontrolovat, zda je server v provozu. Otevřete terminál a následující příkaz.
$ node server.js
a měli byste vidět takový výstup.
Vytvořit naše první cesta
Nyní máme úspěšně testoval server. Náš server je v provozu. Je čas vytvořit první trasu. Začněme jednoduše vytvořením této cesty.
/calculator/about
otevřete server.JS soubor a přidejte následující kód, těsně před init ().
nad kódem vytvoří cestu k dát cestu /kalkulačka / o použití metody GET. V řádku 4 handler funkce zpracovává požadavek a poslat zpět odpověď jako odpověď. V řádku 5 jsme vytvořili proměnnou, která ukládá řetězec JSON. Nakonec řádek vrátí tuto proměnnou jako odpověď ze serveru.
nyní jsme přidali naši první cestu na server. Umožňuje mít rychlý test na nový kód. V terminálu zadejte následující příkaz pro spuštění serveru. (Server můžete zastavit stisknutím kláves CTRL + C)
$ node server.js
umožňuje vypálit pošťáka a otestovat naši první trasu.
jak vidíte, použili jsme metodu GET k odeslání požadavku a URL odpovídá cestě trasy. Máme úspěšný návrat ze serveru jako řetězec JSON.
vynikající máme pracovní kód právě teď. Jeho dobrou praxí uspořádat kód trochu. I když se jedná o malou aplikaci, je to vždy dobrá praxe. Umožňuje přesunout náš směrovací kód do samostatné složky a souboru.
umožňuje nejprve zastavit server stisknutím kláves CTRL + C v terminálu. A v kořenovém adresáři vytvořte adresář s názvem trasy. Použijte následující příkazy v terminálu nebo jej můžete vytvořit pomocí VS kódu.
$ mkdir routes
$ cd routes
$ touch routes.js
nyní by struktura adresářů měla vypadat takto.
nyní otevřete trasu.soubor js uvnitř VS kódu. Dále snížit kód jsme napsali pro směrování na serveru.soubor js. A vložte do trasy.soubor js. Nyní znovu otevřete server.soubor js přidejte následující kód těsně před voláním metody init ().
require(‘./routes/routes’)(server);
Teď máme trochu organizovaný kód. Umožňuje přidat zbytek tras na trasy.soubor js.
nyní jsou všechny naše trasy neporušené. Pokud se podíváte na čísla řádků 19, 36, 53 a 70, cesta má dvě položky uvnitř závorek {}. Ty jsou považovány za parametry v cestě. K těmto parametrům máte přístup, jak je znázorněno na řádcích 22 a 23. Odpočinek je samozřejmý.
nyní umožňuje hvězda serveru zadáním tohoto příkazu v terminálu a otestovat pomocí pošťák.
$ node server.js
Congratulations. You have written your first Node.js based REST API service.
Happy Coding 🙂 !!!