Documenter une API existante

Adopte nestjs-docfy progressivement dans un projet Nest qui a déjà Swagger en place.

Étapes

  1. Installe le package (voir Installation).
  2. Enregistre DocfyModule.forRoot() dans ton AppModule.
  3. Ajoute @WithDocs() à un contrôleur existant.
  4. Lance npx nestjs-docfy generate (ou d'abord --dry-run, pour prévisualiser ce qui serait écrit) pour générer le fichier *.controller.docs.ts à côté du contrôleur, déjà pré-rempli avec des résumés et réponses inférés via docs(), sans toucher à la logique du contrôleur.
  5. Modifie le fichier généré pour ajouter ce qui est spécifique à ton domaine.
  6. Lance npx nestjs-docfy coverage pour mesurer la progression et itérer.
  7. Une fois satisfait, active DocfyModule.forRoot({ strict: true }) pour qu'un contrôleur marqué sans fichier docs fasse échouer le démarrage.