29-1 Installer et configurer Swagger (OpenAPI)

1. Pour commencer à documenter l'API, installez la dépendance Swagger:

npm install @nestjs/swagger

2. Configurer Swagger via main.js. Il faut ajouter à l'application une configuration au démarrage pour préciser quelques informations par rapport à l'API, ainsi que pour générer automatiquement la page de documentation.

src/main.ts

async function bootstrap() {
  const app = await NestFactory.create(AppModule);

  const config = new DocumentBuilder()
    .setTitle('Houdini API')
    .setDescription("API de l'application Houdini")
    .setVersion('1.0')
    .build();
  const document = SwaggerModule.createDocument(app, config);
  SwaggerModule.setup('api', app, document);

  await app.listen(process.env.PORT ?? 3000);
}
bootstrap();