nod.js är en Javascript runtime som bygger på Chromes V8 Javascript-motor. Node är utformad för att bygga skalbara nätverksapplikationer. Vårt fokus i den här artikeln är att bygga ett REST API med Node.js. Vi kommer att bygga en enkel miniräknare tjänst som kommer att göra grundläggande beräkningar och återgå de genererade utgångarna.
Vad är ett REST API?
helt enkelt en RESTful API är ett program programmerare gränssnitt (API) som använder HTTP-begäran för att få, POST, sätta, ta bort data. Även känd som RESTful web services. REST står för REpresentational State Transfer, som är en arkitektonisk stil för att utveckla webbtjänster.
Vad ska vi bygga?
Vi kommer att bygga en enkel webbtjänst som gör några beräkningar och returnerar värdena. Begäran webbadresser och Ut put kommer att se ut så här.
vad du behöver
- en fin liten kodredigerare som Visual Studio Code.
- nod.JS installerat i ditt system.
- a service framework-i den här artikeln använder jag hapi.js (uttalas som Happy JS)
- en app som POSTMAN (en chrome app förlängning) för att testa vår tjänst.
Jag är i macOS High Sierra version 10.13.3. Skalkommandona måste vara likartade på andra plattformar.
Låt oss komma igång
Klicka här för att få det fullständiga arbetsprovet.
först och främst måste du kontrollera versionen av Node.js du har. Låt oss öppna en terminal och skriv följande kommando för att kontrollera versionen av Node.js du har. Jag använder version 8.9.4
$ node --version
OK, skapa nu en katalog för att lagra din kod och navigera in i den genom att använda följande skalkommandon.
$ mkdir calc-service
$ cd calc-service
låter skapa ett vårt projekt.json-fil, genom att skriva detta kommando.
$ npm init
svara på frågorna och ditt projekt.json-filen ska se ut så här.
trevligt, nu har vi skapat basen för vår nod.js tjänst. Nästa sak måste vi installera hapi.js framework. hapi.js är en rik ram kan du skapa webbapplikationer samt tjänster baserade på nod.js.
låter gåtill terminalen och skriv och ange följande kommando.
$ npm install --save [email protected]
npm är en pakethanterare som låter dig installera tusentals moduler för att arbeta med Node.js. Om du tittar på ovanstående kommando har vi instruerat npm att installera hapi version 17. Vi har också bett att uppdatera paketet.json-fil med alternativet Spara.
nu ska din mappstruktur se ut så här.
som du ser hapi.JS dependency har uppdaterats i paketet.json-filen samt de nödvändiga node_modules uppdateras.
låter skapa servern nu
i det här steget kommer vi att leta efter att skapa server som lyssnar på våra förfrågningar. I terminaltypen följande kommando för att skapa servern.js-fil. Detta måste vara i roten till katalogen du är i. Eller så kan du använda ny fil på fliken till vänster i VS-kod.
$ touch server.js
låter lägga till följande kod i servern.js-fil. Den här koden skapar kod som lyssnar på användarförfrågningar på en viss port.
låter kontrollera om servern är igång. Öppna terminalen och följande kommando.
$ node server.js
och du bör se en ut sätta så här.
skapa vår första rutt
nu har vi testat servern framgångsrikt. Vår server är igång nu. Det är dags att skapa den första rutten. Låt oss börja enkelt genom att skapa den här vägen.
/calculator/about
Öppna servern.js fil och lägga till följande kod, strax före init ().
ovan kod skapar en väg till ett ge väg /kalkylator/om att använda en GET-metoden. I linje 4 handler funktionen hanterar begäran och skicka tillbaka ett svar som svar. I raden 5 har vi skapat en variabel som lagrar en JSON-sträng. Slutligen returnerar line den variabeln som ett svar från servern.
nu har vi lagt till vår första rutt till servern. Låt oss ha ett snabbt test på den nya koden. I terminalen skriver du följande kommando för att starta servern. (Du kan stoppa servern genom att trycka på CTRL + C)
$ node server.js
låter fire-up POSTMAN och testa vår första rutt.
som du ser har vi använt GET-metoden för att skicka begäran en URL matchar rutten. Vi har en framgångsrik avkastning från servern som en JSON-sträng.
utmärkt Vi har en fungerande kod just nu. Det är bra att organisera en kod lite. Även om det här är en liten app är det alltid en bra praxis att göra det. Låt oss flytta vår routingkod till en separat mapp och fil.
låter stoppa servern först genom att trycka på CTRL + C i terminalen. Och i rotkatalogen skapar du en katalog med namnet rutter. Använd följande kommandon i terminalen eller så kan du skapa den med VS-kod.
$ mkdir routes
$ cd routes
$ touch routes.js
nu ska katalogstrukturen se ut så här.
katalogstruktur efter att ha skapat rutter katalog och filen.
Öppna nu rutten.js-fil inuti VS-kod. Nästa klippa koden vi skrev för routing i servern.js-fil. Och klistra in i rutten.js-fil. Öppna nu servern igen.js fil lägga till följande kod strax före init () metod samtal.
require(‘./routes/routes’)(server);
nu har vi lite organiserad kod. Låt oss lägga till resten av rutterna till rutterna.js-fil.
nu är alla våra rutter intakta. Om du tittar på radnumren 19, 36, 53 och 70 har sökvägen två poster inom {} parenteser. Dessa behandlas som parametrar i sökvägen. Du kan komma åt dessa parametrar som visas i raderna 22 och 23. Vila är självförklarande.
Nu kan stjärnan servern genom att skriva detta kommando i terminalen och testa den med POSTMAN.
$ node server.js
Congratulations. You have written your first Node.js based REST API service.
Happy Coding 🙂 !!!