Erstellen einer RESTful API für die Benutzerverwaltung mit Node.js

Einführung

In diesem Projekt lernst du, wie du eine RESTful API mit Node.js und Express.js entwickelst. Das Projekt beinhaltet das Erstellen eines einfachen Benutzermanagementsystems, in dem du eine Liste von Benutzern abrufen kannst.

👀 Vorschau

curl http://localhost:8080/list
## Ausgabe:
## {"userlist":[{"id":"1","username":"zhangsan","password":"123456"},{"id":"2","username":"lilei","password":"456"},{"id":"3","username":"hanmeimei","password":"123"}]}

🎯 Aufgaben

In diesem Projekt wirst du lernen:

• Wie du ein Node.js-Projekt einrichtest und Abhängigkeiten installierst
• Wie du einen grundlegenden Express.js-Server erstellst
• Wie du einen GET-Endpunkt implementierst, um eine Liste von Benutzern aus einer JSON-Datei abzurufen
• Wie du die API mit cURL testest

🏆 Errungenschaften

Nach Abschluss dieses Projekts wirst du in der Lage sein:

• Die Grundlagen der RESTful-API-Entwicklung zu verstehen
• Ein Node.js-Projekt einzurichten und die notwendigen Abhängigkeiten zu installieren
• Einen einfachen Express.js-Server zu erstellen
• Einen GET-Endpunkt zu implementieren, um Daten aus einer JSON-Datei abzurufen
• Die API mit cURL zu testen

Projekt einrichten

In diesem Schritt wirst du das Projekt einrichten und die notwendigen Abhängigkeiten installieren.

Der Anfangscode für diese Aufgabe wurde bereits bereitgestellt. Öffne die Codierumgebung, und die Verzeichnisstruktur ist wie folgt:

├── index.js
├── users.json
├── package.json
├── package-lock.json

Als nächstes lade die Abhängigkeiten mit dem Befehl npm install in der Konsole herunter, warte, bis die Abhängigkeiten heruntergeladen sind, und starte dann das Projekt mit dem Befehl npm run dev.

Den GET /list-Endpunkt implementieren

In diesem Schritt wirst du den GET /list-Endpunkt implementieren, um die Liste der Benutzer anzuzeigen.

1. Öffne die Datei index.js im Projektverzeichnis.
2. Locate the TODO section in the file and add the following code to implement the GET /list endpoint:

//TODO
app.get("/list", function (req, res) {
  fs.readFile(
    path.resolve(__dirname, "./users.json"),
    "utf8",
    function (err, data) {
      data = JSON.parse(data);
      res.json(data);
    }
  );
});

Dieser Code liest die Datei users.json, analysiert die JSON-Daten und sendet sie als Antwort.

3. Speichere die Datei index.js.

Den GET /list-Endpunkt testen

In diesem Schritt wirst du den GET /list-Endpunkt testen, um sicherzustellen, dass er richtig funktioniert.

1. Öffne ein neues Terminal in der Lab-Umgebung.
2. Verwende den Befehl curl, um einen GET-Request an den /list-Endpunkt zu senden:

curl http://localhost:8080/list

Du solltest die folgende Ausgabe sehen, die die JSON-Daten aus der users.json-Datei sind:

{"userlist":[{"id":"1","username":"zhangsan","password":"123456"},{"id":"2","username":"lilei","password":"456"},{"id":"3","username":"hanmeimei","password":"123"}]}

Wenn du diese Ausgabe siehst, funktioniert der GET /list-Endpunkt richtig.

Herzlichen Glückwunsch! Du hast das Projekt abgeschlossen und den GET /list-Endpunkt implementiert, um die Liste der Benutzer anzuzeigen.

Zusammenfassung

Herzlichen Glückwunsch! Du hast dieses Projekt abgeschlossen. Du kannst in LabEx weitere Labs absolvieren, um deine Fähigkeiten zu verbessern.