So richten Sie in 5 eine Node.js-API mit TypeScript ein

Heutzutage ist die Erstellung einer effizienten und skalierbaren API mit Node.js und TypeScript einfacher und leistungsfähiger als je zuvor. Bei CodeInit ist es unser Ziel, praktische und unkomplizierte Tutorials bereitzustellen, die Sie bei der Entwicklung professioneller Lösungen unterstützen, die den Marktanforderungen gerecht werden. In diesem Artikel begleite ich Sie Schritt für Schritt durch die Einrichtung einer modernen API unter Verwendung der Best Practices für 2025.

Ob Sie ein Anfänger oder ein erfahrener Entwickler sind, der Ihren Workflow verbessern möchte, dieser Leitfaden ist genau das Richtige für Sie. Lasst uns gemeinsam darin eintauchen!

Warum Node.js und TypeScript verwenden?

Node.js ist nach wie vor eine der beliebtesten Backend-Technologien, und in Kombination mit TypeScript erhalten Sie das Beste aus beiden Welten: Geschwindigkeit und Sicherheit. TypeScript fügt statische Typisierung hinzu, wodurch Ihr Code einfacher zu warten ist und häufige Fehler reduziert werden.

Im Jahr 2025 ist es unerlässlich, Tools zu beherrschen, die die Produktivität steigern und sich an Markttrends anpassen.

Was Sie vor dem Start benötigen

Bevor Sie beginnen, stellen Sie sicher, dass Ihre Umgebung richtig eingerichtet ist. Hier sind die Voraussetzungen:

• Node.js 20 oder höher
• Texteditor – ich empfehle Visual Studio Code
• Grundkenntnisse in JavaScript und Terminal
• npm, Yarn oder pnpm auf Ihrem System installiert

Tipp: Verwenden Sie das integrierte Terminal in VS Code, um diesem Tutorial einfacher zu folgen.

Ich persönlich verwende gerne pnpm. Um pnpm global zu installieren, verwenden Sie den folgenden Befehl:

npm i -g pnpm

Schritt 1: Einrichten der Umgebung

Stellen Sie zunächst sicher, dass Node.js installiert ist:

node -v

Wenn alles richtig eingerichtet ist, sollten Sie die Node.js-Version sehen. Andernfalls laden Sie die neueste Version von der offiziellen Website herunter.

Jetzt erstellen wir die Projektstruktur:

mkdir my-api && cd my-api
pnpm init -y

Dieser Befehl erstellt die Datei package.json, die die Projektabhängigkeiten verwaltet.

Schritt 2: TypeScript installieren

TypeScript ist für die Pflege und Organisation größerer Projekte unerlässlich. Lass es uns installieren:

pnpm install typescript tsx @types/node -D

Als nächstes konfigurieren Sie TypeScript, indem Sie eine tsconfig.json-Datei erstellen:

npx tsc --init

Bearbeiten Sie die Datei, um die Best Practices für 2025 widerzuspiegeln:

{
  "compilerOptions": {
    "target": "ES2022",
    "module": "CommonJS",
    "strict": true,
    "outDir": "dist",
    "rootDir": "src"
  }
}

Erstellen Sie das src-Verzeichnis, um Ihren Code zu organisieren:

mkdir src

Schritt 3: ESLint hinzufügen

Die Aufrechterhaltung eines sauberen Codes ist von entscheidender Bedeutung. Fügen wir ESLint hinzu, um Qualität und Standardisierung sicherzustellen.

Verwenden Sie den folgenden Befehl, um ESLint zu konfigurieren:

pnpm create @eslint/config@latest

Empfohlene ESLint-Einstellungen

• Wie möchten Sie ESLint verwenden? (Um die Syntax zu überprüfen und Probleme zu finden)
• Welche Art von Modulen verwendet Ihr Projekt? (JavaScript-Module (Import/Export))
• Welches Framework nutzt Ihr Projekt? (Keine)
• Verwendet Ihr Projekt TypeScript? (Ja)
• Wo läuft Ihr Code? (Knoten)
• Möchten Sie sie jetzt installieren? (Ja)

Nach der Installation wird die Datei eslint.config.js im Projektstamm erstellt.

Hier ist eine Beispielkonfiguration:

npm i -g pnpm

Fügen Sie ESLint-Befehle hinzu

Fügen Sie die folgenden Skripte zu package.json hinzu:

node -v

Der erste Befehl führt ESLint aus und zeigt Fehler in der Konsole an, während der zweite versucht, die Fehler automatisch zu beheben.

Ausführen:

mkdir my-api && cd my-api
pnpm init -y

oder

pnpm install typescript tsx @types/node -D

Schritt 4: Erstellen der API

Erstellen der Health-Check-Route

Jetzt ist es an der Zeit, mit Ihrer API zu beginnen. Verwenden wir Express, ein minimalistisches Framework für Node.js.

Express und seine Typen installieren:

npx tsc --init

Erstellen Sie die Datei src/index.ts und fügen Sie den folgenden Code hinzu:

{
  "compilerOptions": {
    "target": "ES2022",
    "module": "CommonJS",
    "strict": true,
    "outDir": "dist",
    "rootDir": "src"
  }
}

Fügen Sie das folgende Skript zu package.json hinzu:

mkdir src

Ausführen:

pnpm create @eslint/config@latest

Besuchen Sie: http://localhost:3000/health, um den API-Zustand zu überprüfen.

Hinzufügen der Pokémon-Route

Erweitern wir die API um eine Route, die eine Liste von Pokémon zurückgibt.

Aktualisieren Sie src/index.ts mit dem folgenden Code:

import pluginJs from '@eslint/js';
import globals from 'globals';
import tseslint from 'typescript-eslint';

/** @type {import('eslint').Linter.Config[]} */
export default [
  { files: ['**/*.{js,mjs,cjs,ts}'] },
  { languageOptions: { globals: globals.node } },
  pluginJs.configs.recommended,
  ...tseslint.configs.recommended,
  {
    rules: {
      semi: 'off',
      quotes: ['error', 'single']
    }
  }
];

Testen Sie die Route: http://localhost:3000/pokemons.

Abschluss

In diesem Leitfaden haben Sie erfahren, wie Sie eine moderne API mit Node.js und TypeScript einrichten, indem Sie mit einer einfachen Route beginnen und diese um typisierte Daten erweitern. Das ist erst der Anfang! Auf dieser Grundlage können Sie Authentifizierung, Datenbankverbindungen und vieles mehr implementieren.

Wenn Sie diesen Artikel hilfreich fanden, teilen Sie ihn mit anderen Entwicklern und abonnieren Sie unseren Newsletter für weitere Tipps. Lassen Sie uns gemeinsam die Entwicklungswelt erobern! ?

Das obige ist der detaillierte Inhalt vonSo richten Sie in 5 eine Node.js-API mit TypeScript ein. Für weitere Informationen folgen Sie bitte anderen verwandten Artikeln auf der PHP chinesischen Website!