Documentare OpenAPI cu SwaggerModule în NestJS în NestJS

testing NestJS 10.x / @nestjs/swagger Q&A / Distribuie cod

Generarea automată a documentației interactive Swagger UI (/api/docs) conform standardului OpenAPI 3.0 în aplicațiile NestJS.

Sintaxă
SwaggerModule.createDocument(app, config) / SwaggerModule.setup('api/docs', app, document)

Pachetul oficial @nestjs/swagger permite generarea automată a specificației OpenAPI și servirea interfeței interactive Swagger UI.

Se inițializează în main.ts prin clasa DocumentBuilder, permițând definirea titlului, descrierii, versiunii și a schemelor de autentificare Bearer Auth cu o singură linie de cod.

Exemplu: Configurare Swagger UI în main.ts
import { NestFactory } from '@nestjs/core';
import { DocumentBuilder, SwaggerModule } from '@nestjs/swagger';
import { AppModule } from './app.module';

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

  const config = new DocumentBuilder()
    .setTitle('DexBlog API')
    .setDescription('Documentația oficială a microserviciilor backend')
    .setVersion('1.0')
    .addBearerAuth()
    .build();

  const document = SwaggerModule.createDocument(app, config);
  SwaggerModule.setup('api/docs', app, document);

  await app.listen(3000);
}
bootstrap();

Comunitate & Schimb de cunoștințe

Întrebări & Exemple de Cod: Documentare OpenAPI cu SwaggerModule în NestJS

Ai o nelămurire despre utilizarea comenzii Documentare OpenAPI cu SwaggerModule în NestJS sau ai descoperit un truc / fragment de cod util? Distribuie-l cu ceilalți programatori!

💬

Fii primul care pune o întrebare sau distribuie un fragment de cod / prompt!

Nu au fost adăugate încă întrebări sau exemple de cod pentru această pagină. Dacă ai întâlnit o problemă sau ai un snippet util, adaugă-l mai jos pentru a-i ajuta pe ceilalți.

Comunitate Adaugă o întrebare sau distribuie un cod

Moderare & Siguranță:

Pentru a menține calitatea și securitatea informațiilor, fiecare întrebare sau fragment de cod/prompt este analizat (manual sau prin moderare asistată de AI) înainte de publicare.