Dokumentowanie istniejącego API

Wdrażaj nestjs-docfy stopniowo w projekcie Nest, który ma już skonfigurowany Swagger.

Kroki

  1. Zainstaluj pakiet (zobacz Installation).
  2. Zarejestruj DocfyModule.forRoot() w swoim AppModule.
  3. Dodaj @WithDocs() do istniejącego kontrolera.
  4. Uruchom npx nestjs-docfy generate (albo najpierw --dry-run, żeby zobaczyć podgląd tego, co zostałoby zapisane), aby wygenerować plik *.controller.docs.ts obok kontrolera, już wstępnie wypełniony podsumowaniami i odpowiedziami wnioskowanymi przez docs(), bez dotykania logiki kontrolera.
  5. Edytuj wygenerowany plik, uzupełniając wszystko specyficzne dla Twojej domeny.
  6. Uruchom npx nestjs-docfy coverage, aby zmierzyć postęp i iterować.
  7. Gdy będziesz zadowolony z wyniku, włącz DocfyModule.forRoot({ strict: true }), aby każdy kontroler oznaczony bez pliku docs zawodził przy starcie.