Pentru a transforma documentația Swagger dintr-o simplă listă de rute într-un ghid tehnic complet, @nestjs/swagger furnizează decoratoare specializate:
@ApiTags('Nume'): Grupează rutele pe secțiuni logice.@ApiOperation({ summary: '...' }): Descrie succint rolul fiecărei metode.@ApiResponse({ status: 200, type: ResDto }): Documentează schema de răspuns returnată.@ApiProperty(): Plăsat pe proprietățile DTO pentru a adăuga tipul, exemplul și dacă este opțional.
Exemplu: DTO și Controller documentate complet cu decoratoare Swagger
import { Controller, Post, Body } from '@nestjs/common';
import { ApiTags, ApiOperation, ApiResponse, ApiProperty } from '@nestjs/swagger';
export class CreateProductDto {
@ApiProperty({ example: 'Monitor 4K', description: 'Numele produsului' })
name: string;
@ApiProperty({ example: 1850.5, description: 'Prețul în RON' })
price: number;
}
@ApiTags('Produse')
@Controller('products')
export class ProductsController {
@Post()
@ApiOperation({ summary: 'Creare produs nou în inventar' })
@ApiResponse({ status: 201, description: 'Produs salvat cu succes' })
createProduct(@Body() dto: CreateProductDto) {
return dto;
}
}
Întrebări & Exemple de Cod:
Decoratoare Swagger: @ApiTags, @ApiOperation, @ApiResponse și @ApiPropertyAi o nelămurire despre utilizarea comenzii
Decoratoare Swagger: @ApiTags, @ApiOperation, @ApiResponse și @ApiPropertysau 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.