Swagger/OpenAPI

NestJS 🟡 Mid

Definition

Module @nestjs/swagger qui genere automatiquement la documentation API OpenAPI a partir des decorateurs, DTOs et controllers.

Analogie

Comme un menu de restaurant genere 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 developpeurs frontend.

Anti-pattern

Maintenir une documentation API manuelle qui se desynchronise du code.

Termes lies

#core#interview