Documentar una API existente

Adopta nestjs-docfy de forma incremental en un proyecto Nest que ya tiene Swagger configurado.

Pasos

  1. Instala el paquete (consulta Instalación).
  2. Registra DocfyModule.forRoot() en tu AppModule.
  3. Añade @WithDocs() a un controller existente.
  4. Ejecuta npx nestjs-docfy generate (o primero --dry-run, para previsualizar qué se escribiría) para generar el archivo *.controller.docs.ts junto al controller, ya prerellenado con summaries y respuestas inferidos vía docs(), sin tocar la lógica del controller.
  5. Edita el archivo generado para rellenar cualquier cosa específica de tu dominio.
  6. Ejecuta npx nestjs-docfy coverage para medir el progreso e iterar.
  7. Cuando estés satisfecho, activa DocfyModule.forRoot({ strict: true }) para que cualquier controller marcado sin docs file falle al arrancar.