Ein Leitfaden für Anfänger zu RESTful-APIs in Node.js

Eine REST-API (Representational State Transfer) – manchmal auch als RESTful AP bezeichnet – ist eine API, die HTTP-Anforderungen verwendet, um auf Ressourcen zuzugreifen und diese zu verwenden.

Diese Ressourcen werden häufig im JSON-Format dargestellt, obwohl gelegentlich XML-, Text- und HTML-Formate verwendet werden. REST-APIs sind zu einer Standardmethode für Anwendungen geworden, um Daten über ein Netzwerk durch HTTP-Methoden wie GET, PUT, POST und DELETE auszutauschen. Sie erleichtern das Erstellen, Lesen, Aktualisieren und Löschen von Ressourcen, die allgemein als CRUD-Operationen bezeichnet werden.

In diesem Handbuch wird erläutert, wie Sie Node. JS, um eine einfache CRUD Restful API zu erstellen.

Was Sie mitmachen müssen

Stellen Sie sicher, dass Node.js auf Ihrem lokalen Computer installiert ist. Lauf Knoten -v um zu prüfen, ob Node. JS ist installiert. Dieser Befehl sollte die Versionsnummer zurückgeben.

Verwandt: So installieren Sie Node.js unter Windows

Sie sollten auch eine funktionierende Instanz Ihres Favoriten haben Texteditor (z. B. VS-Code).

Projektaufbau

Erstellen Sie einen Ordner für Ihre Anwendung und navigieren Sie dorthin. Initialisieren Sie auf dem Terminal und in dem gerade erstellten Verzeichnis Paket.json durch Laufen npm-Init.

$ npm init -y 

Der Paket.json hilft Ihnen bei der Installation und Verwaltung von npm-Paketen. Der -y flag erstellt die Datei „package.json“ mit den Standardoptionen, ohne dass Sie die einzelnen Details einrichten müssen. Die Ausgabe auf Ihrem Terminal sollte so aussehen. Beachten Sie, dass der Name unterschiedlich ist, je nachdem, wie Sie Ihren Ordner benannt haben.

Richten Sie den Server ein

Um einen Server zu erstellen, installieren Sie zunächst Express.js und Nodemon. Express.js ist ein Node. Js-Framework, das entwickelt wurde, um die Entwicklung von Webanwendungen und APIs zu vereinfachen. Sie werden es verwenden den Server konfigurieren und die API-Endpunkte. Nodemon hingegen ist ein Entwicklungstool, das Ihren Server neu startet, wenn sich Ihr Anwendungscode ändert.

Führen Sie zur Installation den folgenden Befehl aus äußern und Knotenmon:

npm drücke ich nodemon aus 

Um Ihren Server zu erstellen, erstellen Sie als Nächstes eine Datei und rufen Sie sie auf server.js fügen Sie dann den folgenden Code hinzu.

// Express erforderlich
const express = require("express");
// Express initialisieren
const app = ausdrücken ();
konstanter PORT = 8080;
// JSON analysieren
app.use (express.json());
// URL-codierte Daten parsen
app.use (express.urlencoded({ erweitert: wahr }));
// Server erstellen
app.listen (PORT, () => {
console.log(`Server läuft auf Port ${PORT}`);
});

Erfordern Sie im obigen Code ausdrücklich in Ihrem server.js Datei und initialisieren Sie sie. Konfigurieren Sie dann Express, um JSON- und URL-codierte Daten zu analysieren. Erstellen Sie schließlich einen Server mit der Hör mal zu() Methode von Express.

Verwandt: Was ist Express.js und warum sollten Sie es verwenden?

Erste Schritte: Erstellen Sie ein Array zum Speichern von Benutzerdaten

Der Einfachheit halber verwenden Sie keine Datenbank, sondern ein einfaches Benutzerarray. Fügen Sie in Ihrer app.js den folgenden Code nach der Zeile hinzu, die URL-codierte Daten parst.

konstante Benutzer = [{
 ID: 1,
 Name: "Jane Doe",
 Alter: "22",
 },
 {
 ID: 2,
 Name: "John Doe",
 Alter: "31",
}];

Verwandt: So erstellen Sie eine Datenbank und Sammlung in MongoDB

So richten Sie Routen in Express.js ein

Um Operationen an Ihren Daten durchzuführen, müssen Sie Routing einrichten. Routen bestimmen, wie Ihre Anwendung auf Anforderungen reagiert, die an einen bestimmten Endpunkt gesendet werden. Jede Route hat eine HTTP-Methode, eine URL und eine Handler-Funktion, die die HTTP-Anforderung und -Antwort verarbeitet. Um die Routen einzurichten, fügen Sie Folgendes zu Ihrer hinzu server.js Datei nach Ihrer Benutzer Reihe.

app.post('/create', (req, res) => {
 // Erstellen Sie einen Benutzer
});
app.get('/users', (req, res) => {
 // Ruft alle Benutzer ab
});
app.get('/user/:userID', (req, res) => {
 // Gibt einen Benutzer nach ID zurück
});
app.put('/user/:userID', (req, res) => {
 // Aktualisieren Sie einen Benutzer nach ID
});
app.delete('/delete/:userID', (req, res) => {
 // Einen Benutzer nach ID löschen
});
app.delete('/users', (req, res) => {
 // Alle Benutzer löschen
});

So führen Sie CRUD-Vorgänge in Node. Js

Sie müssen die Funktionen erstellen, die die Benutzerdaten manipulieren und eine Antwort entsprechend der übereinstimmenden Route zurückgeben. Diese Funktionen erstellen, lesen, aktualisieren und löschen Benutzerdaten.

Verwandt: So führen Sie CRUD-Operationen in MongoDB durch

So erstellen Sie einen neuen Benutzer

Um einen neuen Benutzer zu erstellen, müssen Sie:

• Überprüfen Sie, ob der Anforderungstext leer ist – wenn ja, senden Sie eine Fehlerantwort.
• Extrahieren Sie die Benutzerdaten aus dem Anfragetext.
• Validieren Sie die Benutzerdaten.
• Schieben Sie die Benutzerdaten in das Array.

Beachten Sie, dass Sie ein Array nur der Einfachheit halber verwenden. In einem realen Szenario würden Sie mit einer Datenbank interagieren.

Bearbeiten Sie Ihre POST-Route wie folgt.

app.post("/create", (req, res) => {
// Prüfen Sie, ob der Anforderungstext leer ist
if (!Object.keys (req.body).length) {
 return res.status (400).json({
 Nachricht: "Anfragetext darf nicht leer sein",
 });
}
// Verwenden Sie die Objektdestrukturierung, um Name und Alter zu erhalten
const { Name, Alter } = req.body;
if (!Name || !Alter) {
 res.status (400).json({
 Nachricht: "Stellen Sie sicher, dass Sie sowohl Name als auch Alter gesendet haben",
 });
}
const neuerBenutzer = {
 ID: Benutzer.Länge + 1,
 Name,
 das Alter,
};
Versuchen {
 users.push (neuerBenutzer);
 res.status (201).json({
 Meldung: "Erfolgreich einen neuen Benutzer erstellt",
 });
} Fang (Fehler) {
 res.status (500).json({
 Meldung: "Fehler beim Erstellen des Benutzers",
 });
}
});

So lesen Sie Benutzer

Um alle Benutzer abzurufen, geben Sie das Benutzer-Array in Ihrer Antwort zurück.

app.get("/users", (req, res) => {
 Versuchen {
 res.status (200).json({
 Benutzer
 });
 } Fang (Fehler) {
 res.status (500).json({
 Meldung: "Fehler beim Abrufen aller Benutzer",
 });
 }
});

Wenn Sie diese Route mit Postman testen, sollten Sie das Array von Benutzern im Antworttext erhalten.

So rufen Sie nur einen Benutzer ab:

• Rufen Sie die Benutzer-ID aus dem URL-Parameter ab.
• Benutzen finden() um zu identifizieren, welche spezifischen Benutzerdaten Sie anfordern.
• Geben Sie den Benutzer in der Antwort zurück.

app.get("/users/:userID", (req, res) => {
 const id = parseInt (req.params.userID);
 Konsole.log (ID);
 Versuchen {
 let user = users.find ((user) => user.id id);
 if (!Benutzer) {
 return res.status (404).json({
 Meldung: "Benutzer nicht gefunden",
 });
 }
 res.status (200).json({
 Nutzer,
 });
 } Fang (Fehler) {
 res.status (500).json({
 Meldung: "Fehler beim Abrufen des Benutzers",
 });
 }
});

So aktualisieren Sie Benutzer

So aktualisieren Sie den Benutzer:

• Rufen Sie die Benutzer-ID aus der URL ab.
• Benutzen finden() um zu prüfen, ob der Benutzer existiert.
• Benutzen Index von() um den Index des Benutzers zu erhalten, auf den verwiesen wird.
• Verwenden Sie den Index, um die Benutzerdaten mit den über den Anforderungstext gesendeten Daten zu bearbeiten.

app.put("/users/:userID", (req, res) => {
 Versuchen {
 const id = parseInt (req.params.userID);
 let user = users.find ((user) => user.id id);
 if (!Benutzer) {
 return res.status (404).json({
 Meldung: "Benutzer nicht gefunden",
 });
 }
 const userIDX = users.indexOf (Benutzer);
 users[userIDX].name = req.body.name || Benutzer[Benutzer-IDX].Name;
 Benutzer[BenutzerIDX].Alter = req.body.Alter || Benutzer[Benutzer-IDX].Alter;
 res.status (200).json({
 Meldung: „Benutzer erfolgreich aktualisiert“,
 Nutzer,
 });
 } Fang (Fehler) {
 res.status (500).json({
 Meldung: "Fehler beim Abrufen des Benutzers",
 });
 }
});

So löschen Sie Benutzer

Sie können einen Benutzer oder alle Benutzer löschen.

So löschen Sie einen Benutzer:

• Rufen Sie die Benutzer-ID aus der URL ab
• Benutzen finden() um zu prüfen, ob der Benutzer existiert
• Benutzen findIndex() um den Index des Benutzers zu erhalten, auf den verwiesen wird.
• Benutzen spleißen() um den Benutzer an diesem Index zu löschen.

app.delete("/users/:userID", (req, res) => {
 Versuchen {
 const id = req.params.userID;
 let userIDX = users.findIndex((user) => user.id id);
 if (!userIDX) {
 res.status (404).json({
 Meldung: "Benutzer nicht gefunden",
 });
 }
 users.spleiß (userIDX, 1);
 res.status (200).json({
 Meldung: „Benutzer erfolgreich gelöscht“,
 Benutzer,
 });
 } Fang (Fehler) {
 res.status (500).json({
 Meldung: "Benutzer konnte nicht gelöscht werden",
 });
 }
});

Um alle Benutzer zu löschen, spleißen Sie das gesamte Array.

app.delete("/users", (req, res) => {
 Versuchen {
 users.spleiß (0, users.length);
 res.status (200).json({
 Meldung: „Alle Benutzer erfolgreich gelöscht“,
 Benutzer,
 });
 } Fang (Fehler) {
 res.status (500).json({
 Meldung: „Benutzer konnten nicht gelöscht werden“,
 x,
 });
 }
});

Erfahren Sie mehr über RESTful-APIs

In diesem Tutorial wird erläutert, wie Sie eine grundlegende RESTful-API in Node erstellen. JS. Sie haben gelernt, wie Sie einen Express-Server erstellen, Routen einrichten und schließlich Handler-Funktionen erstellen, die mit Ihren Daten über HTTP-Anforderungen/Antworten interagieren.

Es gibt jedoch einige wichtige Themen, die hier nicht behandelt werden und die Sie weiter untersuchen sollten, einschließlich der Verbindung Ihrer Anwendung mit einer Datenbank wie MongoDB und der Sicherung von Routen.

Wie eine MongoDB-Datenbank Ihre Daten besser organisieren kann

MongoDB (von „humongous“) ist eine plattformübergreifende dokumentenorientierte Datenbank, die als Alternative zu MySQL verwendet wird. Aber was bedeutet das?

Lesen Sie weiter

Über den Autor