Comment créer une API REST avec Node.js et Express.js (pour les débutants)

La construction de l'API REST est une compétence de base pour le développement du dos. Cet article vous guidera comment utiliser node.js

et express.js créer une API de repos simple. Ce guide fournira un processus clair et étape par étape pour construire votre première API. Remarque:

Ce didacticiel n'intégre aucune base de données, mais utilise un tableau de mémoire.

Qu'est-ce que l'API REST?

---

API REST

(Interface de programmation d'application de transmission d'état similaire) est un ensemble de règles et d'accord pour la création et les services Web interactifs. Il utilise la méthode HTTP (telle que GET, POST, PUT ET DELITE) pour effectuer des opérations, et renvoie généralement des données au format JSON.

Conditions préalables Avant de commencer, assurez-vous que vous avez installé le contenu suivant:

---

node.js

: Téléchargez et installez-le à partir de nodejs.org.

Éditeur de code

: Utilisez n'importe quel éditeur que vous aimez, comme le code Visual Studio, le texte sublime ou l'atome.
1. Postman (facultatif): outils utilisés pour tester votre point de fin de l'API. Téléchargez-le sur Postman.com.
2. Étape 1: Définissez votre projet
3. 1. Créez le répertoire de projet Ouvrez votre terminal et créez un nouveau répertoire pour votre projet:

---

2. Initialisez le projet Node.js

Exécutez les commandes suivantes pour créer un fichier package.json:

Le logo

-y remplira automatiquement la valeur par défaut de votre projet.

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

Étape 2: Installez le sac requis

1. Installer Express.js

<code>npm init -y</code>

Express.js est un cadre Web léger de Node.js. Utilisez la commande suivante pour l'installer:

---

2. Installez NODEMON (Facultatif)

Chaque fois que vous modifiez le code, Nodemon redémarre automatiquement votre serveur. Installez-le comme dépendances de développement:

Étape 3: Créez le serveur de base

<code>npm install express</code>

1. Créez le fichier index.js

Dans votre répertoire de projet, créez un fichier appelé index.js:

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

---

2. Définissez le serveur

ouvrir index.js et ajouter le code suivant:

3. Exécutez le serveur

<code>touch index.js</code>

Utilisez la commande suivante pour démarrer le serveur:

Si vous installez NODEMON, veuillez utiliser:

// 导入 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}`);
});

Dans le navigateur, visitez

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

, monde! ".

<code>node index.js</code>

Étape 4: Ajouter un opération CRUD

Créons une simple API REST pour gérer la liste des projets. Nous utiliserons un tableau de mémoire pour stocker des données.

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

1. Créez un tableau de mémoire Ajouter ce voyage après <添>:

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

2. Définir le routage crud

Obtenir / éléments : Obtenez tous les projets

<code>npm init -y</code>

get / items /: id

: Obtenez un seul élément par id

post / éléments

<code>npm install express</code>

: Créez un nouveau projet

put / items /: id

: Mettez à jour le projet via l'ID

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

supprimer / items /: id : Supprimer le projet via id

<code>touch index.js</code>

Étape 5: Testez votre API

Utiliser 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}`);
});

ou

---

curl

Testez votre point de terminaison de l'API:

get https://www.php.cn/link/8a701b176cc140888936dad15d046a -rettrieve tous les projets.

Post
1. https://www.php.cn/link/8a701b176cc140888936dad15d046a - Créer un nouveau projet. Envoyez un corps principal JSON similaire à <的>. get
2. https://www.php.cn/link/8a701b176cc140888936dad15d046a/1 —— Récupérez un seul élément via id. put {"name": "项目 1"} https://www.php.cn/link/8a701b176cc140888936dad15d046a/1
Projet de mise à jour. Envoyez un corps principal JSON similaire à <的>.
3. Delete https://www.php.cn/link/8a701b176cc140888936dad15d046a/1 - Delete items via id.
4. Étape 6: Ajouter un traitement d'erreur (facultatif) Pour gérer les erreurs à l'échelle mondiale, ajoutez ce middleware à la fin du fichier index.js: {"name": "已更新的项目 1"}
5. Étape 7: Organisez votre code (facultatif) Avec le développement du projet, vous pouvez organiser le code dans un fichier et un dossier séparés. Par exemple:

Routes /

---

: Définissez l'itinéraire.

Controller /

: Traitement de la logique métier.

<code>node index.js</code>

Modèles /

---

: Définissez la structure des données.

le code final

Il s'agit du fichier complet index.js:
Conclusion
• Félicitations! Vous avez construit une API REST simple avec Node.js et Express.js. Ce n'est que le début - vous pouvez également faire plus de choses, comme l'intégration de bases de données, l'ajout de vérification d'identité ou le déploiement de votre API au cloud. Continuez à essayer, je vous souhaite un codage heureux!

Ce qui précède est le contenu détaillé de. pour plus d'informations, suivez d'autres articles connexes sur le site Web de PHP en chinois!