Knoten.js ist eine Javascript-Laufzeit, die auf der V8-Javascript-Engine von Chrome aufbaut. Node wurde entwickelt, um skalierbare Netzwerkanwendungen zu erstellen. Unser Fokus in diesem Artikel liegt auf dem Erstellen einer REST-API mit Node.js. Wir werden einen einfachen Rechnerdienst erstellen, der grundlegende Berechnungen durchführt und die generierten Ausgaben zurückgibt.
Was ist eine REST API?
Einfach eine RESTful-API ist eine Anwendungsprogrammierschnittstelle (API), die HTTP-Anforderungen verwendet, um Daten abzurufen, zu posten, zu SETZEN und zu LÖSCHEN. Auch bekannt als RESTful Web Services. REST steht für REpresentational State Transfer, ein Architekturstil für die Entwicklung von Webdiensten.
Was werden wir bauen?
Wir werden einen einfachen Webdienst erstellen, der einige Berechnungen durchführt und die Werte zurückgibt. Die Anforderungs-URLs und die Ausgabe sehen folgendermaßen aus.
Was Sie brauchen
- Ein netter kleiner Code-Editor wie Visual Studio Code.
- Knoten.js in Ihrem System installiert.
- Ein Service-Framework — In diesem Artikel verwende ich hapi.js (ausgesprochen als Happy JS)
- Eine App wie POSTMAN (eine Chrome-App-Erweiterung), um unseren Service zu testen.
Ich bin in macOS High Sierra Version 10.13.3. Die Shell-Befehle müssen auf anderen Plattformen ähnlich sein.
Lets get started
Klicken Sie hier, um das vollständige Arbeitsprobe zu erhalten.
Zuerst müssen Sie die Version von Node überprüfen.js Sie haben. Öffnen Sie ein Terminal und geben Sie den folgenden Befehl ein, um die Version des Knotens zu überprüfen.js Sie haben. Ich verwende Version 8.9.4
$ node --version
OK, erstellen Sie nun ein Verzeichnis zum Speichern Ihres Codes und navigieren Sie mit den folgenden Shell-Befehlen hinein.
$ mkdir calc-service
$ cd calc-service
Erstellen wir ein eigenes Projekt.json-Datei, indem Sie diesen Befehl eingeben.
$ npm init
Beantworten Sie die Fragen und Ihr Projekt.json-Datei sollte so aussehen.
Schön, jetzt haben wir die Basis unseres Knotens erstellt.guter Service. Als nächstes müssen wir den Hapi installieren.js Rahmen. hapi.js ist ein reichhaltiges Framework, mit dem Sie Webanwendungen sowie Dienste basierend auf Knoten erstellen können.js.
Gehen wir zum Terminal und geben den folgenden Befehl ein.
$ npm install --save [email protected]
npm ist ein Paketmanager, mit dem Sie Tausende von Modulen installieren können, um mit Node zu arbeiten.js. Wenn Sie sich den obigen Befehl ansehen, haben wir das npm angewiesen, hapi Version 17 zu installieren. Außerdem haben wir darum gebeten, das Paket zu aktualisieren.json-Datei mit der Option Speichern.
Nun sollte Ihre Ordnerstruktur so aussehen.
Wie Sie den Hapi sehen.die js-Abhängigkeit wurde im Paket aktualisiert.die JSON-Datei sowie die erforderlichen node_modules werden aktualisiert.
Lassen Sie uns jetzt den Server erstellen
In diesem Schritt werden wir einen Server erstellen, der auf unsere Anfragen hört. Geben Sie im Terminal den folgenden Befehl ein, um den Server zu erstellen.js-Datei. Dies muss sich im Stammverzeichnis des Verzeichnisses befinden, in dem Sie sich befinden. Oder Sie können Neue Datei auf der Registerkarte linker Bereich in VS Code verwenden.
$ touch server.js
Fügen Sie den folgenden Code in den Server ein.js-Datei. Dieser Code erstellt Code, der auf Benutzeranforderungen an einem bestimmten Port wartet.
Überprüfen wir, ob der Server läuft. Öffnen Sie das Terminal und führen Sie den folgenden Befehl aus.
$ node server.js
Und Sie sollten einen solchen Ausgang sehen.
Erstellen Sie unsere erste Route
Jetzt haben wir den Server erfolgreich getestet. Unser Server ist jetzt in Betrieb. Es ist Zeit, die erste Route zu erstellen. Beginnen wir einfach, indem wir diesen Pfad erstellen.
/calculator/about
Öffnen Sie den Server.js-Datei und fügen Sie den folgenden Code, kurz vor init().
Der obige Code erstellt eine Route zu einem bestimmten Pfad von /Rechner /über eine GET-Methode. In der Zeile 4 behandelt die Handlerfunktion die Anforderung und sendet eine Antwort als Antwort zurück. In der Zeile 5 haben wir eine Variable erstellt, die eine JSON-Zeichenfolge speichert. Schließlich gibt line diese Variable als Antwort vom Server zurück.
Jetzt haben wir unsere erste Route zum Server hinzugefügt. Lassen Sie uns einen schnellen Test des neuen Codes durchführen. Geben Sie im Terminal den folgenden Befehl ein, um den Server zu starten. (Sie können den Server stoppen, indem Sie STRG + C drücken)
$ node server.js
Lassen Sie uns POSTMAN starten und unsere erste Route testen.
Wie Sie sehen, haben wir die GET-Methode verwendet, um die Anfrage zu senden, und die URL entspricht dem Pfad der Route. Wir haben eine erfolgreiche Rückgabe vom Server als JSON-String.
Ausgezeichnet, wir haben gerade einen funktionierenden Code. Es empfiehlt sich, einen Code ein wenig zu organisieren. Obwohl dies eine kleine App ist, ist es immer eine gute Praxis, dies zu tun. Verschieben wir unseren Routing-Code in einen separaten Ordner und eine separate Datei.
Stoppen Sie den Server zuerst, indem Sie STRG + C im Terminal drücken. Erstellen Sie im Stammverzeichnis ein Verzeichnis mit dem Namen routes. Verwenden Sie die folgenden Befehle im Terminal oder erstellen Sie sie mit VS Code.
$ mkdir routes
$ cd routes
$ touch routes.js
Nun sollte die Verzeichnisstruktur so aussehen.
Öffnen Sie nun die Route.js-Datei in VS Code. Als nächstes schneiden Sie den Code, den wir für das Routing im Server geschrieben haben.js-Datei. Und in die Route einfügen.js-Datei. Öffnen Sie nun den Server erneut.js-Datei fügen Sie den folgenden Code kurz vor init () Methodenaufruf.
require(‘./routes/routes’)(server);
Jetzt haben wir ein bisschen Code organisiert. Fügen wir den Rest der Routen zu den Routen hinzu.js-Datei.
Jetzt sind alle unsere Routen intakt. Wenn Sie sich die Zeilennummern 19, 36, 53 und 70 ansehen, hat der Pfad zwei Einträge in {} Klammern. Diese werden als Parameter im Pfad behandelt. Sie können auf diese Parameter zugreifen, wie in den Zeilen 22 und 23 gezeigt. Rest ist selbsterklärend.
Lassen Sie uns nun den Server starten, indem Sie diesen Befehl in das Terminal eingeben und mit POSTMAN testen.
$ node server.js
Congratulations. You have written your first Node.js based REST API service.
Happy Coding 🙂 !!!