Wie man in 30 Minuten eine REST API mit TypeScript schreibt

Einführung: Warum TypeScript für REST-APIs?

Moderne Webentwicklung ist ohne die Erstellung effizienter und sicherer APIs nicht denkbar. TypeScript, als Obermenge von JavaScript, bietet statische Typisierung, die die Anzahl der Laufzeitfehler erheblich reduziert und die Lesbarkeit des Codes verbessert. In dieser Anleitung zeigen wir Ihnen, wie Sie in nur 30 Minuten eine vollwertige REST-API in TypeScript schreiben. Sie lernen, wie Sie ein Projekt einrichten, grundlegende Endpunkte erstellen und Fehler behandeln. Dieses Tutorial ist perfekt für Anfänger, die schnell den Aufbau serverseitiger Anwendungen meistern möchten.

Umgebungseinrichtung und Abhängigkeitsinstallation

Zunächst müssen Sie ein neues Projekt erstellen und alle erforderlichen Pakete installieren. Stellen Sie sicher, dass Node.js (Version 18 oder höher) und npm installiert sind.

Schritt 1: Projektinitialisierung

Öffnen Sie ein Terminal und führen Sie die folgenden Befehle aus:

mkdir my-rest-apicd my-rest-apinpm init -y

Schritt 2: Installieren von TypeScript und Abhängigkeiten

Installieren Sie TypeScript, Express und die erforderlichen Typen:

npm install expressnpm install -D typescript @types/node @types/express ts-node nodemon

• express — Framework zum Erstellen eines Servers.
• typescript — TypeScript-Compiler.
• @types/express — Typen für Express.
• ts-node — zum direkten Ausführen von TypeScript.
• nodemon — automatischer Serverneustart bei Änderungen.

Schritt 3: Konfigurieren der tsconfig.json

Erstellen Sie eine Datei tsconfig.json im Projektverzeichnis:

{  "compilerOptions": {    "target": "ES2020",    "module": "commonjs",    "outDir": "./dist",    "rootDir": "./src",    "strict": true,    "esModuleInterop": true,    "skipLibCheck": true  },  "include": ["src/**/*"],  "exclude": ["node_modules"]}

Erstellen eines grundlegenden Servers in TypeScript

Jetzt erstellen wir die Ordnerstruktur und die Hauptserverdatei.

Schritt 4: Projektstruktur

Erstellen Sie einen Ordner src und eine Datei src/index.ts:

mkdir srctouch src/index.ts

Schritt 5: Schreiben des Servers

Öffnen Sie src/index.ts und fügen Sie den folgenden Code hinzu:

import express, { Request, Response } from 'express';

const app = express();const PORT = process.env.PORT || 3000;

// Middleware zum Parsen von JSONapp.use(express.json());

// Einfache Routeapp.get('/', (req: Request, res: Response) => {    res.send('REST-API auf TypeScript funktioniert!');});

// Server startenapp.listen(PORT, () => {    console.log(`Server läuft auf Port ${PORT}`);});

Schritt 6: Hinzufügen von Skripten zu package.json

Aktualisieren Sie package.json, indem Sie Skripte für Entwicklung und Build hinzufügen:

"scripts": {  "dev": "nodemon --exec ts-node src/index.ts",  "build": "tsc",  "start": "node dist/index.js"}

Starten Sie nun den Server mit dem Befehl npm run dev. Sie sollten die Meldung "Server läuft auf Port 3000" sehen.

Implementieren von CRUD-Endpunkten

Lassen Sie uns ein einfaches Datenmodell erstellen und Create-, Read-, Update- und Delete-Operationen (CRUD) implementieren. Als Beispiel verwenden wir die Entität "Aufgabe".

Schritt 7: Erstellen des Modells und des Speichers

Erstellen Sie eine Datei src/models/Task.ts:

export interface Task {    id: number;    title: string;    completed: boolean;}

// Temporärer Arbeitsspeicherexport const tasks: Task[] = [    { id: 1, title: 'TypeScript lernen', completed: false },    { id: 2, title: 'REST-API schreiben', completed: false },];

Schritt 8: Erstellen von Routen

Erstellen Sie eine Datei src/routes/tasks.ts:

import { Router, Request, Response } from