Node.js - RESTful API

Hallo, ambitionierte Programmierer! Heute werden wir eine aufregende Reise in die Welt von Node.js und RESTful APIs antreten. Keine Sorge, wenn diese Begriffe derzeit wie eine fremde Sprache klingen - bis zum Ende dieses Tutorials werden Sie fließend "REST" sprechen! ?

Node.js - RESTFul API

Was ist REST-Architektur?

REST, oder Representational State Transfer, ist wie ein Satz von Regeln, nach denen Computer sich im Internet untereinander unterhalten sollten. Stellen Sie sich vor, Sie sind in einem Restaurant. Sie (der Client) bitten den Kellner (die API) um eine Speisekarte (Daten). Der Kellner kocht das Essen nicht selbst, sondern geht in die Küche (Server), um das zu holen, was Sie benötigen. Diese Hin- und Herbewegung ist ähnlich wie REST funktioniert!

Schlüsselprinzipien von REST:

Client-Server: Trennung der Sorge zwischen Benutzeroberfläche und DatenSpeicherung.
Stateless: Jede Anfrage vom Client zum Server muss alle Informationen enthalten, die zum Verständnis der Anfrage erforderlich sind.
Cachebar: Antworten müssen sich selbst als cachebar oder nicht cachebar definieren.
Uniformes Interface: Eine standardisierte Möglichkeit der Interaktion mit dem Server.
Schichtensystem: Der Client kann nicht erkennen, ob er direkt mit dem Server oder mit einem Vermittler verbunden ist.

HTTP-Methoden

Nun sprechen wir über HTTP-Methoden. Diese sind wie Verben, die dem Server sagen, welche Aktion er ausführen soll. Hier sind die Hauptmethoden:

Methode	Beschreibung	Beispielnutzung
GET	Daten abrufen	Benutzerprofil abrufen
POST	Neue Daten erstellen	Neuen Blogbeitrag hinzufügen
PUT	Bestehende Daten aktualisieren	Benutzerdetails bearbeiten
DELETE	Daten entfernen	Tweet löschen
PATCH	Daten teilweise修改	Nur die E-Mail des Benutzers aktualisieren

Sehen wir uns diese in Aktion mit einigen einfachen Node.js-Codebeispielen an!

GET-Anfrage Beispiel:

const http = require('http');

const server = http.createServer((req, res) => {
if (req.method === 'GET' && req.url === '/api/users') {
res.writeHead(200, { 'Content-Type': 'application/json' });
res.end(JSON.stringify({ users: ['Alice', 'Bob', 'Charlie'] }));
}
});

server.listen(3000, () => {
console.log('Server läuft auf Port 3000');
});

In diesem Beispiel erstellen wir einen einfachen Server, der auf eine GET-Anfrage zu '/api/users' mit einer JSON-Liste von Benutzern antwortet. Wenn Sie diesen Code ausführen und 'http://localhost:3000/api/users' in Ihrem Browser besuchen, sehen Sie die Liste der Benutzer!

POST-Anfrage Beispiel:

const http = require('http');

const server = http.createServer((req, res) => {
if (req.method === 'POST' && req.url === '/api/users') {
let body = '';
req.on('data', chunk => {
body += chunk.toString();
});
req.on('end', () => {
const newUser = JSON.parse(body);
console.log('Neuer Benutzer hinzugefügt:', newUser);
res.writeHead(201, { 'Content-Type': 'application/json' });
res.end(JSON.stringify({ message: 'Benutzer erfolgreich erstellt' }));
});
}
});

server.listen(3000, () => {
console.log('Server läuft auf Port 3000');
});

Dieses Beispiel zeigt, wie man eine POST-Anfrage zum Hinzufügen eines neuen Benutzers behandelt. Es hört auf eingehende Daten, verarbeitet sie und sendet eine Bestätigung, dass der Benutzer erstellt wurde.

RESTful Web Services

Nun, da wir die Grundlagen verstehen, tauchen wir ein in die Erstellung einer vollständigen RESTful API mit Express, einem beliebten Node.js-Framework, das das Erstellen von Webanwendungen und APIs zum Kinderspiel macht!

Zuerst installieren wir Express:

npm init -y
npm install express

Nun erstellen wir eine einfache RESTful API für eine Buchbibliothek:

const express = require('express');
const app = express();
app.use(express.json());

let books = [
{ id: 1, title: 'Der Große Gatsby', author: 'F. Scott Fitzgerald' },
{ id: 2, title: 'Wer die SchönheittoBe Kill a Mockingbird', author: 'Harper Lee' }
];

// GET alle Bücher
app.get('/api/books', (req, res) => {
res.json(books);
});

// GET ein bestimmtes Buch
app.get('/api/books/:id', (req, res) => {
const book = books.find(b => b.id === parseInt(req.params.id));
if (!book) return res.status(404).send('Buch nicht gefunden');
res.json(book);
});

// POST ein neues Buch
app.post('/api/books', (req, res) => {
const book = {
id: books.length + 1,
title: req.body.title,
author: req.body.author
};
books.push(book);
res.status(201).json(book);
});

// PUT (aktualisieren) ein Buch
app.put('/api/books/:id', (req, res) => {
const book = books.find(b => b.id === parseInt(req.params.id));
if (!book) return res.status(404).send('Buch nicht gefunden');

book.title = req.body.title;
book.author = req.body.author;
res.json(book);
});

// DELETE ein Buch
app.delete('/api/books/:id', (req, res) => {
const book = books.find(b => b.id === parseInt(req.params.id));
if (!book) return res.status(404).send('Buch nicht gefunden');

const index = books.indexOf(book);
books.splice(index, 1);
res.json(book);
});

app.listen(3000, () => console.log('Server läuft auf Port 3000'));

Dieses Beispiel erstellt eine vollständige RESTful API zur Verwaltung einer Buchbibliothek. Lassen Sie uns das aufschlüsseln:

Wir verwenden app.get() um GET-Anfragen zu behandeln, sowohl für alle Bücher als auch für spezifische Bücher nach ID.
app.post() behandelt die Erstellung neuer Bücher.
app.put() ermöglicht die Aktualisierung bestehender Bücher.
app.delete() ermöglicht das Entfernen von Büchern aus unserer Bibliothek.

Jede Route folgt den RESTful-Prinzipien, indem sie geeignete HTTP-Methoden und Statuscodes verwendet.

Testen Ihrer API

Um Ihre API zu testen, können Sie Tools wie Postman oder curl verwenden. Hier ist ein Beispiel mit curl:

# GET alle Bücher
curl http://localhost:3000/api/books

# POST ein neues Buch
curl -X POST -H "Content-Type: application/json" -d '{"title":"1984","author":"George Orwell"}' http://localhost:3000/api/books

# PUT (aktualisieren) ein Buch
curl -X PUT -H "Content-Type: application/json" -d '{"title":"Aktualisierter Titel","author":"Aktualisierter Autor"}' http://localhost:3000/api/books/1

# DELETE ein Buch
curl -X DELETE http://localhost:3000/api/books/1

Und da haben Sie es! Sie haben gerade Ihre erste RESTful API mit Node.js und Express erstellt. Denken Sie daran, Übung macht den Meister. Versuchen Sie, Ihrer Buchbibliotheks-API mehr Funktionen hinzuzufügen, wie z.B. die Suche nach Büchern oder das Sortieren nach verschiedenen Kriterien.

Das Erstellen von APIs ist wie das Bauen einer Brücke zwischen verschiedenen Softwareanwendungen. Mit jeder API, die Sie erstellen, eröffnen Sie neue Möglichkeiten, wie Programme interagieren und Daten austauschen können. Weitersuchen, weitercodieren und vor allem: Viel Spaß auf Ihrer Reise, um ein Experte für Node.js zu werden!

Credits: Image by storyset

Vorheriges Tutorial:

Node.js - Express-Framework

Nächstes Tutorial:

Node.js - Puffer