Documentare un'API esistente

Passaggi

1. Installa il pacchetto (vedi Installazione).
2. Registra DocfyModule.forRoot() nel tuo AppModule.
   app.module.ts

   // app.module.ts
   import { Module } from '@nestjs/common';
   import { DocfyModule } from 'nestjs-docfy';
   
   @Module({
     imports: [DocfyModule.forRoot()],
   })
   export class AppModule {}

3. Aggiungi @WithDocs() a un controller esistente.
   users.controller.ts

   // users.controller.ts
   import { Controller, Get, Post, Body } from '@nestjs/common';
   import { WithDocs } from 'nestjs-docfy';
   
   @WithDocs()
   @Controller('users')
   export class UsersController {
     // route handlers only, no Swagger decorators here
   }

4. Esegui npx nestjs-docfy generate (o prima --dry-run, per un'anteprima di cosa verrebbe scritto) per generare il file *.controller.docs.ts accanto al controller, già pre-compilato con summary e risposte inferite tramite docs(), senza toccare la logica del controller.
   bash

   npx nestjs-docfy generate --dry-run
   npx nestjs-docfy generate

   users.controller.docs.ts (generated)

   // Generated by nestjs-docfy@x.y.z. Edit freely, use --force to merge new methods, --overwrite to regenerate from scratch
   import { docs } from 'nestjs-docfy';
   import { ApiTags, ApiOperation, ApiResponse, ApiBody } from '@nestjs/swagger';
   import { UsersController } from './users.controller';
   import { CreateUserDto } from './dto/create-user.dto';
   import { UserEntity } from './entities/user.entity';
   
   docs(UsersController, {
     classDecorators: [ApiTags('users')],
     methods: {
       // GET / → async findAll(): Promise<UserEntity[]>
       findAll: [
         ApiOperation({ summary: 'Find all' }),
         ApiResponse({ status: 200, description: 'OK', type: [UserEntity] }),
       ],
   
       // POST / → async create(dto: CreateUserDto): Promise<UserEntity>
       create: [
         ApiOperation({ summary: 'Create' }),
         ApiBody({ type: CreateUserDto }),
         ApiResponse({ status: 201, description: 'Created', type: UserEntity }),
         ApiResponse({ status: 400, description: 'Bad Request' }),
       ],
     },
   });

5. Modifica il file generato per aggiungere ciò che è specifico del tuo dominio.
6. Esegui npx nestjs-docfy coverage per misurare i progressi e iterare.
   bash

   npx nestjs-docfy coverage

   text

   Controllers: 42
   Endpoints: 187
   
   Documented: 174
   Missing docs: 13
   
   Coverage: 93.0%

7. Quando sei soddisfatto, abilita DocfyModule.forRoot({ strict: true }) in modo che qualsiasi controller marcato senza un file docs fallisca all'avvio.
   ts

   DocfyModule.forRoot({ strict: true });