Formations — 1 037 leçons en français

Accueil › Node.js › Tester une API de bout en bout

Tester une API de bout en bout

Tester une APIavance

Un test d'API envoie une vraie requête HTTP à votre application entière. Pour cela, l'application doit être importable sans démarrer de serveur.

// app.js — déclare, n'écoute pas
import express from "express";
import { routeurCommandes } from "./routes/commandes.js";

export const app = express();
app.use(express.json());              // parse le corps — ne le valide pas
app.use("/commandes", routeurCommandes);
// serveur.js — le seul endroit qui ouvre un port
import { app } from "./app.js";

app.listen(Number(process.env.PORT ?? 3000));

Le test

import test from "node:test";
import assert from "node:assert/strict";
import request from "supertest";

import { app } from "./app.js";

test("POST /commandes crée la commande", async () => {
  const reponse = await request(app)
    .post("/commandes")
    .send({ articleId: 1, quantite: 2 });

  assert.equal(reponse.status, 201);
  assert.match(reponse.headers.location, /^\/commandes\/\d+$/);
  assert.equal(reponse.body.quantite, 2);
});

Vous ne choisissez aucun port. Le client reçoit l'application, l'attache à un port éphémère que le système attribue, envoie la requête, puis referme. Deux fichiers de test lancés en parallèle ne se gênent pas.

Ce test traverse tout : les intergiciels dans leur ordre réel, l'analyse du corps, la route, la sérialisation, le statut. C'est précisément la zone où une API se trompe.

Les termes à connaître

Application exportée

L'application Express déclarée dans un module qui n'appelle pas listen. Un autre fichier démarre le serveur, les tests importent l'application telle quelle.

Client de test

Un objet qui reçoit l'application et envoie des requêtes sans que vous choisissiez de port. supertest est le plus répandu.

Port éphémère

listen(0) laisse le système attribuer un port libre. On lit ensuite server.address().port. Aucun conflit possible entre deux suites.

EADDRINUSE

L'erreur levée quand le port demandé est déjà pris. En test, elle vient presque toujours d'un port codé en dur ou d'un serveur non fermé.

Assertion de réponse

Vérifier le statut, puis les en-têtes qui comptent, puis les champs du corps qui comptent — jamais le corps entier à l'égalité.

Jeton de test

Un jeton signé dans le test avec la même clé que l'application, lue depuis l'environnement. On ne passe pas par l'écran de connexion.

Intergiciel

Une fonction traversée avant le gestionnaire. Son ordre est invisible dans le code métier et ne se vérifie que par un appel HTTP complet.

Lire l'explication détaillée et faire le quiz →

Cette page présente la partie essentielle de la leçon. Les exemples commentés, les pièges courants et les trois questions de quiz sont dans l'application.