API docs that live in your NestJS repo

1@ApiTags('Bookings')
2@Controller('v1/bookings')
3export class BookingsController {
4  /** Books seats on a flight for up to nine passengers. */
5  @Post()
6  @ApiOperation({ summary: 'Create a booking' })
7  @ApiResponse({ status: 409, description: 'Flight is full.' })
8  create(@Body() body: CreateBookingDto) {
9    return this.bookings.create(body);
10  }
11}
12 
13export class CreateBookingDto {
14  @ApiProperty({ example: 'flt_2031_proxima' })
15  flightId: string;
16  @ApiProperty({ type: [PassengerDto], maxItems: 9 })
17  passengers: PassengerDto[];
18  @ApiPropertyOptional({ example: ['14A'] })
19  seats?: string[];
20}