csomópont.a js egy Javascript futásidejű, amely a Chrome V8 Javascript motorjára épül. A csomópont skálázható hálózati alkalmazások létrehozására szolgál. A hangsúly ebben a cikkben, hogy építsenek egy REST API segítségével Node.js. Építünk egy egyszerű számológép szolgáltatást, amely elvégzi az alapvető számításokat és visszaadja a generált kimeneteket.
mi az a REST API?
egyszerűen egy RESTful API egy alkalmazások programozók felület (API), amely HTTP kérést kap, POST, PUT, adatok törlése. RESTful web services néven is ismert. A REST a Reprezentációs állami transzfert jelenti, amely a webszolgáltatások fejlesztésének építészeti stílusa.
mit fogunk építeni?
egy egyszerű webes szolgáltatást fogunk építeni, amely elvégzi a számításokat és visszaadja az értékeket. A kérés URL-je és az out put így fog kinézni.
amire szükséged van
- egy szép kis kódszerkesztő, mint a Visual Studio Code.
- csomópont.js telepítve van a rendszerben.
- szolgáltatási keretrendszer — ebben a cikkben a hapi-t használom.js (ejtsd Boldog JS)
- egy app, mint a POSTMAN (a chrome app kiterjesztés), hogy teszteljék a szolgáltatást.
a macOS High Sierra 10.13.3 verziójában vagyok. A shell parancsoknak hasonlónak kell lenniük más platformokon.
kezdjük el
kattintson ide a teljes munkaminta megtekintéséhez.
először is ellenőriznie kell a Node verzióját.js van. Nyissunk meg egy terminált, és írjuk be a következő parancsot a Node verziójának ellenőrzéséhez.js van. A 8.9-es verziót használom.4
$ node --version
OK, most hozzon létre egy könyvtárat a kód tárolására, és navigáljon bele a következő shell parancsokkal.
$ mkdir calc-service
$ cd calc-service
létrehozhatunk egy projektet.json fájl, írja be ezt a parancsot.
$ npm init
válaszoljon a kérdésekre és a projektre.a json fájlnak így kell kinéznie.
szép, most létrehoztuk a Csomópontunk alapját.js szolgáltatás. A következő dolog, amit telepítenünk kell a hapi-t.js keretrendszer. hapi.a js egy gazdag keretrendszer, amely lehetővé teszi webes alkalmazások, valamint Node alapú szolgáltatások létrehozását.js.
Lets goto a terminál és írja be a következő parancsot.
$ npm install --save [email protected]
az npm egy csomagkezelő, amely lehetővé teszi több ezer modul telepítését a Node használatához.js. Ha megnézzük a fenti parancsot, utasítottuk az npm-et a hapi 17-es verziójának telepítésére. Azt is kérte, hogy frissítse a csomagot.json fájl a Mentés opcióval.
most a mappastruktúrának így kell kinéznie.
ahogy a hapi-t látja.js függőség frissült a csomagban.JSON fájl, valamint a szükséges node_modules frissülnek.
lehetővé teszi, hogy hozzon létre a szerver most
ebben a lépésben fogunk keresni létrehozása szerver, amely meghallgatja a kéréseket. A terminál típusa következő parancs a kiszolgáló létrehozásához.js fájl. Ennek a könyvtár gyökerében kell lennie. Vagy használhatja új fájl a bal oldali ablaktábla lapon a VS kódban.
$ touch server.js
a következő kódot adhatjuk hozzá a szerverhez.js fájl. Ez a kód olyan kódot hoz létre, amely meghallgatja az adott port felhasználói kéréseit.
ellenőrizhetjük, hogy a szerver működik-e. Nyissa meg a terminált és a következő parancsot.
$ node server.js
és látnod kell egy ilyen out-ot.
a 3000-es porton futó szerver
készítse el első útvonalunkat
most sikeresen teszteltük a szervert. A szerverünk már működik. Ideje létrehozni az első útvonalat. Kezdjük egyszerű létrehozásával ezt az utat.
/calculator/about
nyissa meg a szervert.js fájlt, és adja hozzá a következő kódot, közvetlenül az init () előtt.
fenti kód létrehoz egy útvonalat, hogy egy adok útját /számológép/körülbelül egy GET módszer. A 4. sorban a kezelő funkció kezeli a kérést, és válaszként visszaküldi a választ. Az 5. sorban létrehoztunk egy változót, amely egy JSON karakterláncot tárol. Végül a line ezt a változót adja vissza a szerver válaszaként.
most hozzáadtuk az első útvonalat a szerverhez. Lehetővé teszi, hogy egy gyors teszt az új kódot. A terminálban írja be a következő parancsot a kiszolgáló indításához. (A szervert a CTRL + C billentyűkombinációval állíthatja le)
$ node server.js
Lets Tűz-Up POSTMAN and test our first route.
sikeres visszatérés a szerverről az útvonal tesztelése.
amint látja, a GET metódust használtuk a kérés elküldéséhez, hogy az URL megfeleljen az útvonal elérési útjának. Van egy sikeres visszatérés a szerverről, mint egy JSON karakterlánc.
Kiváló van egy működő kódot most. A jó gyakorlat, hogy szervezzen egy kódot egy kicsit. Annak ellenére, hogy ez egy kis alkalmazás, mindig jó gyakorlat. Lehetővé teszi, hogy az útválasztási kódot külön mappába és fájlba helyezzük.
először állítsa le a kiszolgálót a CTRL + C megnyomásával a terminálon. A gyökérkönyvtárban hozzon létre egy routes nevű könyvtárat. Használja a következő parancsokat a terminálon, vagy létrehozhatja a VS kód használatával.
$ mkdir routes
$ cd routes
$ touch routes.js
most a könyvtárszerkezetnek így kell kinéznie.
könyvtárszerkezet létrehozása után útvonalak könyvtár és a fájl.
most nyissa meg az útvonalat.js fájl belsejében VS kód. Ezután vágja le a kódot, amelyet a szerveren történő útválasztáshoz írtunk.js fájl. Illessze be az útvonalat.js fájl. Most nyissa meg újra a szervert.js fájl adja hozzá a következő kódot közvetlenül az init() metódushívás előtt.
require(‘./routes/routes’)(server);
most van egy kicsit szervezett kódunk. Adja hozzá a többi útvonalat az útvonalakhoz.js fájl.
most minden útvonalunk érintetlen. Ha megnézzük a 19-es, 36-os, 53-as és 70-es sorszámokat, az útvonalnak két bejegyzése van a {} zárójelben. Ezeket az elérési út paramétereként kezeljük. Ezeket a paramétereket a 22.és 23. sorban látható módon érheti el. A pihenés magától értetődő.
most lehetővé teszi csillag a szerver beírja ezt a parancsot a terminál, és tesztelje a POSTMAN.
$ node server.js
Congratulations. You have written your first Node.js based REST API service.
Happy Coding 🙂 !!!