Node.js er en Javascript runtime, der bygger på Chromes V8 Javascript-motor. Node er designet til at opbygge skalerbare netværksapplikationer. Vores fokus i denne artikel er at opbygge en REST API ved hjælp af Node.js. Vi vil bygge en simpel regnemaskine tjeneste, som vil gøre grundlæggende beregninger og returnere de genererede udgange.
Hvad er en REST API?
Simply a RESTful API er en APPLIKATIONSPROGRAMMERGRÆNSEFLADE (API), der bruger HTTP-anmodning til at hente, sende, sætte, slette data. Også kendt som RESTful internettjenester. REST står for REpresentational State Transfer, som er en arkitektonisk stil til udvikling af internettjenester.
hvad skal vi bygge?
vi vil bygge en simpel internettjeneste, der vil lave nogle beregninger og returnere værdierne. Anmodningen URL ‘ er og out put vil se sådan ud.
hvad du har brug for
- en dejlig lille kodeditor som Visual Studio Code.
- Node.JS installeret i dit system.
- en serviceramme-i denne artikel bruger jeg hapi.js (udtales som Happy JS)
- en app som POSTMAN (en chrome-appudvidelse) til at teste vores service.
Jeg er i macOS High Sierra version 10.13.3. Shell-kommandoerne skal være ens på andre platforme.
lad os komme i gang
Klik her for at få den fulde arbejdsprøve.
først og fremmest skal du kontrollere versionen af Node.js du har. Lad os åbne en terminal og skrive følgende kommando for at kontrollere versionen af Node.js du har. Jeg bruger version 8.9.4
$ node --version
OK, Opret nu en mappe til at gemme din kode og navigere ind i den ved hjælp af følgende shell-kommandoer.
$ mkdir calc-service
$ cd calc-service
lad os oprette et vores projekt.JSON fil, ved at skrive denne kommando.
$ npm init
Besvar spørgsmålene og dit projekt.JSON-filen skal se sådan ud.
Nice, nu har vi oprettet basen af vores Node.js service. Næste ting vi skal installere hapi.JS rammer. hapi.js er en rig ramme giver dig mulighed for at oprette internet applikationer samt tjenester baseret på Node.js.
lad os gåtil terminalen og skriv og indtast følgende kommando.
$ npm install --save [email protected]
npm er en pakkehåndtering, der giver dig mulighed for at installere tusindvis af moduler til at arbejde med Node.js. Hvis du ser på ovenstående kommando, har vi instrueret npm om at installere hapi version 17. Vi har også bedt om at opdatere pakken.JSON-fil ved hjælp af indstillingen Gem.
nu skal din mappestruktur se sådan ud.
som du ser hapi.JS afhængighed er blevet opdateret i pakken.JSON fil samt de nødvendige node_modules opdateres.
lad os oprette serveren nu
i dette trin ser vi ud til at skabe server, der lytter til vores anmodninger. I terminaltypen følgende kommando for at oprette serveren.JS-fil. Dette skal være i roden af den mappe, du er i. Eller du kan bruge ny fil i fanen venstre rude i VS-kode.
$ touch server.js
div>
lad os tilføje følgende kode på serveren.JS-fil. Denne kode opretter kode, der lytter til brugeranmodninger på en given port.
lad os kontrollere, om serveren er i gang. Åbn terminalen og følgende kommando.
$ node server.js
og du bør se en ud put som denne.
Opret vores første rute
nu har vi testet serveren med succes. Vores server er oppe og køre nu. Det er på tide at oprette den første rute. Lad os starte simpelt ved at oprette denne sti.
/calculator/about
Åbn serveren.JS fil og tilføje følgende kode, lige før init().
ovenfor kode opretter en rute til en give sti af /lommeregner/om at bruge en GET metode. I linje 4 håndterer funktion håndterer anmodningen og sende tilbage et svar som svar. I linje 5 har vi oprettet en variabel, der gemmer en JSON-streng. Endelig returnerer line denne variabel som et svar fra serveren.
nu har vi tilføjet vores første rute til serveren. Lad os få en hurtig test på den nye kode. I terminalen skriv følgende kommando for at starte serveren. (Du kan stoppe serveren ved at trykke på CTRL + C)
$ node server.js
lader brand-up postbud og teste vores første rute.
som du ser, har vi brugt GET-metoden til at sende anmodningen og URL ‘ en matcher rutens sti. Vi har et vellykket afkast fra serveren som en JSON-streng.
fremragende vi har en arbejdskode lige nu. Det er god praksis at organisere en kode lidt. Selvom dette er en lille app, er det altid en god praksis at gøre det. Lad os flytte vores routing kode i en separat mappe og fil.
lad os stoppe serveren først ved at trykke på CTRL + C i terminalen. Og i rodmappen skal du oprette en mappe med navnet ruter. Brug følgende kommandoer i terminalen, eller du kan oprette den ved hjælp af VS-kode.
$ mkdir routes
$ cd routes
$ touch routes.js
nu skal katalogstrukturen se sådan ud.
åbn nu ruten.js fil inde VS kode. Skær derefter koden, vi skrev til routing på serveren.JS-fil. Og indsæt inde i ruten.JS-fil. Åbn nu serveren igen.JS-fil tilføj følgende kode lige før init () metodeopkald.
require(‘./routes/routes’)(server);
nu har vi en smule organiseret kode. Lad os tilføje resten af ruterne til ruterne.JS-fil.
nu er alle vores ruter intakte. Hvis du ser på linjenumrene 19, 36, 53 og 70, har stien to poster inde i {} parenteser. Disse behandles som parametre i stien. Du kan få adgang til disse parametre som vist i linjerne 22 og 23. Hvile er selvforklarende.
lad os nu stjerne serveren ved at skrive denne kommando i terminalen og teste den ved hjælp af postbud.
$ node server.js
Congratulations. You have written your first Node.js based REST API service.
Happy Coding 🙂 !!!