Node.js is een Javascript runtime die voortbouwen op Chrome V8 Javascript engine. Node is ontworpen om schaalbare netwerktoepassingen te bouwen. Onze focus in dit artikel is om een REST API te bouwen met behulp van Node.js. We zullen het bouwen van een eenvoudige Calculator dienst die basisberekeningen zal doen en terug te keren de gegenereerde outputs.
Wat is een REST API?
Simply a RESTful API is een applications programmers interface (API) die HTTP request gebruikt om gegevens te krijgen, plaatsen, plaatsen, verwijderen. Ook bekend als RESTful web services. REST staat voor REpresentational State Transfer, een architectonische stijl voor het ontwikkelen van webservices.
wat gaan we bouwen?
We zullen een eenvoudige webservice bouwen die wat berekeningen doet en de waarden teruggeeft. Het verzoek URL ‘ s en de out put zal er zo uitzien.
wat u nodig hebt
- een leuke kleine code-editor zoals Visual Studio Code.
- Node.js geïnstalleerd in uw systeem.
- een service framework – in dit artikel gebruik ik hapi.js (uitgesproken als Happy JS)
- een app zoals POSTMAN (een Chrome app extensie) om onze service te testen.
Ik ben in macOS High Sierra versie 10.13.3. De shell commando ‘ s moeten vergelijkbaar zijn op andere platforms.
laten we beginnen
Klik hier om het volledige werkende voorbeeld te krijgen.
Allereerst moet u de versie van Node controleren.js heb je. Laten we een terminal openen en het volgende commando typen om de versie van Node te controleren.js heb je. Ik Gebruik versie 8.9.4
$ node --version
OK, Maak nu een map om je code op te slaan, en navigeer er in met behulp van de volgende shell commando ‘ s.
$ mkdir calc-service
$ cd calc-service
laten we een ons project maken.json bestand, door dit commando te typen.
$ npm init
beantwoord de vragen en uw project.json dossier moet er zo uitzien.
Nice, nu hebben we de basis van onze Node aangemaakt.js service. Vervolgens moeten we de hapi installeren.JS framework. hapi.js is een rijk kader kunt u webapplicaties evenals diensten op basis van knooppunt te creëren.js.
laat de terminal gaan en typ en voer het volgende commando in.
$ npm install --save [email protected]
npm is een pakketbeheerder waarmee u duizenden modules kunt installeren om met Node te werken.js. Als u naar bovenstaande opdracht kijkt, hebben wij de NPM opdracht gegeven hapi versie 17 te installeren. Ook hebben we gevraagd om het pakket bij te werken.json-bestand met behulp van de optie Opslaan.
nu zou uw mappenstructuur er zo uit moeten zien.
zoals u de hapi ziet.js afhankelijkheid is bijgewerkt in het pakket.json bestand evenals de vereiste node_modules worden bijgewerkt.
laten we nu de server aanmaken
In deze stap zullen we kijken naar het maken van een server die naar onze verzoeken zal luisteren. Typ in de terminal het volgende commando om de server te maken.js file. Dit moet in de root van de directory staan waarin je je bevindt. Of u kunt Nieuw bestand gebruiken in het linkerdeelvenster tabblad in VS Code.
$ touch server.js
Laat de volgende code toevoegen in de server.js file. Deze code zal code aanmaken die zal luisteren naar verzoeken van gebruikers op een bepaalde poort.
laten we controleren of de server actief is. Open de terminal en het volgende commando.
$ node server.js
en je zou een out put als deze moeten zien.
maak onze eerste route
nu hebben we de server met succes getest. Onze server draait nu. Het is tijd om de eerste route te maken. Laten we eenvoudig beginnen met het creëren van dit pad.
/calculator/about
Open de server.JS bestand en voeg de volgende code, net voor init().
bovenstaande code maakt een route aan naar een opgegeven pad van/calculator / over met behulp van een GET-methode. In de regel 4 handler functie behandelt het verzoek en stuur een antwoord terug als het antwoord. In de regel 5 hebben we een variabele gemaakt die een JSON string opslaat. Tenslotte geeft line die variabele terug als antwoord van de server.
nu hebben we onze eerste route aan de server toegevoegd. Laten we een snelle test op de nieuwe code. Typ in de terminal het volgende commando om de server te starten. (U kunt de server stoppen door op CTRL + C te drukken)
$ node server.js
laat Postman opstarten en onze eerste route testen.
zoals u ziet hebben we GET-methode gebruikt om het verzoek te verzenden en de URL komt overeen met het pad van de route. We hebben een succesvolle terugkeer van de server als een JSON string.
uitstekend we hebben nu een werkende code. Het is een goede gewoonte om een code een beetje te organiseren. Ook al is dit een kleine app, het is altijd een goede praktijk om het te doen. Laten we onze routing code verplaatsen naar een aparte map en bestand.
laten we de server eerst stoppen door op CTRL + C te drukken in de terminal. En maak in de hoofdmap een map met de naam routes. Gebruik de volgende commando ‘ s in de terminal of u kunt het maken met behulp van VS-Code.
$ mkdir routes
$ cd routes
$ touch routes.js
nu zou de mapstructuur er zo uit moeten zien.
open nu de route.js-bestand in VS-Code. Knip vervolgens de code die we schreven voor routing in de server.js file. En plak binnen de route.js file. Open nu opnieuw de server.js bestand voeg de volgende code net voor init () methode aanroep.
require(‘./routes/routes’)(server);
nu hebben we een Bit georganiseerde code. Laten we de rest van de routes toevoegen aan de routes.js file.
nu zijn al onze routes intact. Als je kijkt naar de regelnummers 19, 36, 53 en 70 heeft het pad twee regels tussen {} haakjes. Deze worden behandeld als parameters in het pad. U kunt toegang krijgen tot deze parameters zoals weergegeven in de regels 22 en 23. Rust spreekt voor zich.
laat nu de server staren door dit commando in de terminal te typen en het te testen met POSTMAN.
$ node server.js
Congratulations. You have written your first Node.js based REST API service.
Happy Coding 🙂 !!!