Skriver din første Node.js REST API-Tjeneste

Node.js er En Javascript runtime som bygger På Chrome V8 Javascript-motor. Node er designet for å bygge skalerbare nettverksapplikasjoner. Vårt fokus i denne artikkelen er å bygge EN REST API ved Hjelp Av Node.js. Vi skal bygge en Enkel Kalkulator tjeneste som vil gjøre grunnleggende beregninger og returnere de genererte utganger.

Hva ER EN REST API?

Bare En RESTful API Er et program programmerere grensesnitt (API) som bruker HTTP forespørsel FOR Å FÅ, POST, SETTE, SLETTE data. Også Kjent Som RESTful web services. REST står For REpresentational State Transfer, som er en arkitektonisk stil for å utvikle webtjenester.

Hva skal vi bygge?

Vi skal bygge en enkel webtjeneste som vil gjøre noen beregninger og returnere verdiene. Forespørselen Nettadresser og ut put vil se slik ut.

Hva du trenger

  1. En fin liten kodeditor som Visual Studio Code.
  2. Node.js installert i systemet ditt.
  3. a service framework-I denne artikkelen bruker jeg hapi.js (uttales Som Glad JS)
  4. en app SOM POSTMAN (en chrome app forlengelse) for å teste vår tjeneste.

jeg er i macOS High Sierra versjon 10.13.3. Shell-kommandoene må være like på andre plattformer.

Lar komme i gang

Klikk her For å få full arbeids prøven.

Først og fremst må du sjekke Versjonen Av Node.js du har. Lar åpne en terminal og skriv inn følgende kommando for å sjekke Versjonen Av Node.js du har. Jeg bruker versjon 8.9.4

$ node --version

OK, opprett nå en katalog for å lagre koden din, og naviger inn i den ved å bruke følgende shell-kommandoer.

$ mkdir calc-service
$ cd calc-service

lar oss lage et prosjekt.json-fil, ved å skrive denne kommandoen.

$ npm init

Svar på spørsmålene og prosjektet ditt.json-filen skal se slik ut.

Fint, Nå har Vi opprettet basen av Noden vår.js service. Neste ting må vi installere hapi.js rammeverk. hapi.js er et rikt rammeverk lar deg lage webapplikasjoner samt tjenester basert På Node.js.

Lar goto terminalen og skriv inn og skriv inn følgende kommando.

$ npm install --save [email protected]

npm er en pakkebehandling som lar deg installere tusenvis av moduler for Å jobbe Med Node.js. Hvis du ser på kommandoen ovenfor, har vi instruert npm å installere hapi versjon 17. Vi har også bedt om å oppdatere pakken.json-fil ved hjelp av alternativet lagre.

nå skal mappestrukturen din se slik ut.

hapi.js oppdatert som en avhengighet

som du ser hapi.js avhengighet har blitt oppdatert i pakken.json fil samt de nødvendige node_modules er oppdatert.

lar opprette serveren nå

i dette trinnet vil vi være ute å lage server som vil lytte til våre forespørsler. I terminal type følgende kommando for å opprette serveren.js-fil. Dette må være i roten til katalogen du er i. Eller du kan bruke Ny Fil i venstre rute-fanen I VS-Kode.

$ touch server.js

div>

opprett ny fil

lar legge til følgende kode i serveren.js-fil. Denne koden vil opprette kode som vil lytte etter brukerforespørsler pa en gitt port.

lar sjekke om serveren er oppe og går. Åpne terminalen og følgende kommando.

$ node server.js 

Og du bør se en ut satt som dette.

Server som kjører på port 3000

lag vår første rute

nå har vi testet serveren. Vår server er oppe og går nå. Det er på tide å lage den første ruten. La oss starte enkelt ved å lage denne banen.

/calculator/about

Åpne serveren.js fil og legge til følgende kode, like før init ().

over kode oppretter en rute for a gi banen til / kalkulator / om ved HJELP AV EN GET-metode. I linje 4 handler-funksjonen handterer foresporselen og sender tilbake et svar som svar. I linje 5 har vi opprettet en variabel som lagrer EN JSON-streng. Endelig returnerer linjen den variabelen som et svar fra serveren.

Nå har vi lagt til vår første rute til serveren. Kan ha en rask test på den nye koden. I terminalen skriver du inn følgende kommando for å starte serveren. (Du kan stoppe serveren ved å trykke CTRL + C)

$ node server.js

Lar brann OPP POSTBUD og teste vår første rute.

teste ruten.

som du ser har vi brukt GET metode for å sende forespørselen en URL samsvarer med banen til ruten. Vi har en vellykket retur fra serveren som EN JSON-streng.

Utmerket vi har en fungerende kode akkurat nå. Det er god praksis å organisere en kode litt. Selv om dette er en liten app, er det alltid en god praksis å gjøre det. Lar flytte vår rutingskode til en egen mappe og fil.

lar stoppe serveren først ved å trykke CTRL + C i terminalen. Og i rotkatalogen, opprett en katalog som heter ruter. Bruk følgende kommandoer i terminalen, eller du kan opprette DEN ved HJELP AV VS-Kode.

$ mkdir routes 
$ cd routes
$ touch routes.js

nå skal katalogstrukturen se slik ut.

Katalogstruktur etter å ha opprettet ruter katalog og filen.

åpne nå ruten.js fil INNE VS Kode. Neste kutt koden vi skrev for ruting i serveren.js-fil. Og lim inn i ruten.js-fil. Åpne nå serveren igjen.js-fil legg til følgende kode like før init () metodekall.

require(‘./routes/routes’)(server);

nå har vi en litt organisert kode. Lar legge resten av rutene til rutene.js-fil.

nå er alle våre ruter intakte. Hvis du ser på linjenumrene 19, 36, 53 og 70, har banen to oppføringer i {} parenteser. Disse behandles som parametere i banen. Du kan få tilgang til disse parameterne som vist i linjene 22 og 23. Resten er selvforklarende.

lar nå star serveren ved å skrive denne kommandoen i terminalen og teste DEN med POSTMAN.

$ node server.js 

Tested path of /calculator/add/10/20

Congratulations. You have written your first Node.js based REST API service.

Happy Coding 🙂 !!!

Legg igjen en kommentar

Din e-postadresse vil ikke bli publisert.