Swagger/OpenAPI

NestJS 🟡 Mid

Définition

Module @nestjs/swagger qui génère automatiquement la documentation API OpenAPI a partir des décorateurs, DTOs et controllers. Depuis la version 12.0.0 (27 août 2026, alignée sur NestJS 12), le module est publie en ESM natif et peut refléter des schémas Standard Schema (Zod, Valibot) dans le document OpenAPI via l'option standardSchemaConverter, en plus du flux class-validator historique qui reste entièrement supporte.

Analogie

Comme un menu de restaurant génère automatiquement a partir des plats disponibles en cuisine.

Exemple de code

const config = new DocumentBuilder()
  .setTitle('My API')
  .setVersion('1.0')
  .addBearerAuth()
  .build();
const doc = SwaggerModule.createDocument(app, config);
SwaggerModule.setup('api', app, doc);

Cas d'usage

Fournir une documentation API interactive et toujours a jour pour les développeurs frontend.

Anti-pattern

Maintenir une documentation API manuelle qui se desynchronise du code.

Termes liés

#core#interview#nest12

En entretien

À quoi sert le module @nestjs/swagger ?
Il génère automatiquement la documentation API OpenAPI à partir des décorateurs, DTOs et controllers, ce qui la garde toujours synchronisée avec le code. Depuis la version 12.0.0, il est publié en ESM natif et peut refléter des schémas Standard Schema comme Zod ou Valibot via l'option standardSchemaConverter.
Quel anti-pattern ce module permet d'éviter ?
Maintenir une documentation API manuelle, qui finit toujours par se désynchroniser du code réel. La génération automatique, comme un menu de restaurant généré à partir des plats disponibles en cuisine, élimine ce risque.

Sources

github.com/nestjs/swagger/releases/tag/12.0.0

Fiche mise à jour le 2026-09-27