So erstellen Sie eine REST -API mit Node.js und Express.js (für Anfänger)

Aufbau von REST -API ist eine grundlegende Fähigkeit für die Back -End -Entwicklung. In diesem Artikel wird Ihnen die Verwendung von node.js

und express.js eine einfache REST -API erstellen. Dieser Leitfaden bietet einen klaren Schritt -By -Step -Prozess, um Ihre erste API zu erstellen. <:> Hinweis:

Dieses Tutorial integriert keine Datenbank, sondern verwendet Speicherarray.

Was ist REST -API?

---

rest api

(ähnliche Programmierschnittstellen der staatlichen Übertragungsanwendung) ist eine Reihe von Regeln und Vereinbarungen zum Erstellen und interaktiven Webdiensten. Es verwendet die HTTP -Methode (z. B. GET, Post, Put und Löschen), um Vorgänge auszuführen, und gibt normalerweise Daten im JSON -Format zurück.

Voraussetzung für Bedingungen Vor dem Start haben Sie den folgenden Inhalt installiert:

---

node.js

: Laden Sie es von nodejs.org herunter und installieren Sie es.

Code -Editor

: Verwenden Sie einen beliebigen Editor, z. B. Visual Studio Code, Sublime Text oder Atom.
1. Postman (optional): Tools, mit denen Sie Ihren API -Endpunkt testen können. Laden Sie es von Postman.com herunter.
2. Schritt 1: Setzen Sie Ihr Projekt
3. 1. Erstellen Sie das Projektverzeichnis Öffnen Sie Ihr Terminal und erstellen Sie ein neues Verzeichnis für Ihr Projekt:

---

2. initialisieren Sie das Node.js -Projekt

Führen Sie die folgenden Befehle aus, um eine Paket.json -Datei zu erstellen:

-y Logo füllt den Standardwert des Projekts automatisch ein.

<code>mkdir my-rest-api
cd my-rest-api</code>

Schritt 2: Installieren Sie die erforderliche Tasche

1. install express.js

<code>npm init -y</code>

express.js ist ein leichtes Web -Framework von node.js. Verwenden Sie den folgenden Befehl, um es zu installieren:

---

2.. NODEMON (optional)

installieren

Wenn Sie den Code ändern, starten Sie Ihren Server automatisch neu. Installieren Sie es als Entwicklungsabhängigkeiten:

Schritt 3: Erstellen Sie den Basisserver

<code>npm install express</code>

1. erstellen Sie die Datei index.js

Erstellen Sie in Ihrem Projektverzeichnis eine Datei namens Index.js:

<code>npm install --save-dev nodemon</code>

---

2. Setzen Sie den Server

öffnen index.js und fügen Sie den folgenden Code hinzu:

3. Führen Sie den Server

aus

<code>touch index.js</code>

Verwenden Sie den folgenden Befehl, um den Server zu starten:

Wenn Sie Nodemon installieren, verwenden Sie bitte:

// 导入 express 模块
const express = require('express');

// 创建 express 实例
const app = express();

// 定义端口号
const PORT = 3000;

// 解析 JSON 主体的中间件
app.use(express.json());

// 定义一个简单的路由
app.get('/', (req, res) => {
    res.send('Hello, World!');
});

// 启动服务器并在指定的端口上监听
app.listen(PORT, () => {
    console.log(`服务器正在运行在 http://localhost:${PORT}`);
});

Besuchen Sie im Browser

https://www.php.cn/link/8cad09283d1d6c5fb08daec8a576a72d

, World!

<code>node index.js</code>

Schritt 4: CRUD -Operation

hinzufügen

Erstellen wir eine einfache REST -API, um die Projektliste zu verwalten. Wir werden Speicherarray verwenden, um Daten zu speichern.

<code>npx nodemon index.js</code>

1. erstellen Speicherarray Fügen Sie diese Reise nach <添>:

hinzu

<code>mkdir my-rest-api
cd my-rest-api</code>

2. Definieren Sie Crud Routing

get /items : Alle Projekte erhalten

<code>npm init -y</code>

GET /Elemente /: ID

: Erhalten Sie ein einzelnes Element nach ID

post /items

<code>npm install express</code>

: Erstellen Sie ein neues Projekt

put /items /: id

: Aktualisieren Sie das Projekt über die ID

<code>npm install --save-dev nodemon</code>

Elemente löschen /: id : das Projekt über ID

löschen

<code>touch index.js</code>

Schritt 5: Testen Sie Ihre API

verwenden postman

// 导入 express 模块
const express = require('express');

// 创建 express 实例
const app = express();

// 定义端口号
const PORT = 3000;

// 解析 JSON 主体的中间件
app.use(express.json());

// 定义一个简单的路由
app.get('/', (req, res) => {
    res.send('Hello, World!');
});

// 启动服务器并在指定的端口上监听
app.listen(PORT, () => {
    console.log(`服务器正在运行在 http://localhost:${PORT}`);
});

oder

---

curl

Testen Sie Ihren API -Endpunkt:

Get https://www.php.cn/link/8a701b176cc140888936dad15d046a -RetRieve alle Projekte.

post
1. https://www.php.cn/link/8a701b176cc140888936dad15d046a - Erstellen Sie ein neues Projekt. Senden Sie eine JSON -Hauptbehörde ähnlich wie <的>. Get
2. https://www.php.cn/link/8a701b176cc140888936dad15d046a/1 - - A ID ID abrufen. put {"name": "项目 1"} https://www.php.cn/link/8a701b176cc140888936dad15d046a/1
Update -Projekt. Senden Sie eine JSON -Hauptbehörde ähnlich wie <的>.
3. löschen https://www.php.cn/link/8a701b176cc140888936dad15d046a/1 - Elemente über ID löschen.
4. Schritt 6: Fehlerbehandlung (optional) hinzufügen Um mit Fehlern global umzugehen, fügen Sie diese Middleware am Ende der Index.js -Datei hinzu: {"name": "已更新的项目 1"}
5. Schritt 7: organisieren Sie Ihren Code (optional) Mit der Entwicklung des Projekts können Sie den Code in einer separaten Datei und einem separaten Ordner organisieren. Zum Beispiel:

Routen/

---

: Definieren Sie die Route.

Controller/

: Verarbeitungsgeschäftslogik.

<code>node index.js</code>

Modelle/

---

: Definieren Sie die Datenstruktur.

Der endgültige Code

Dies ist die vollständige Index.js -Datei:
Schlussfolgerung
• Herzlichen Glückwunsch! Sie haben eine einfache REST -API mit Node.js und Express.js erstellt. Dies ist nur der Anfang. Sie können auch mehr Dinge tun, z. B. das Integrieren von Datenbanken, das Hinzufügen von Identitätsüberprüfung oder Bereitstellung Ihrer API in die Cloud. Versuchen Sie es weiter, ich wünsche Ihnen eine glückliche Codierung!

Das obige ist der detaillierte Inhalt vonSo erstellen Sie eine REST -API mit Node.js und Express.js (für Anfänger). Für weitere Informationen folgen Sie bitte anderen verwandten Artikeln auf der PHP chinesischen Website!