Eine bestehende API dokumentieren

Führe nestjs-docfy schrittweise in einem Nest-Projekt ein, das schon Swagger eingerichtet hat.

Schritte

  1. Installier das Paket (siehe Installation).
  2. Registrier DocfyModule.forRoot() in deinem AppModule.
  3. Füg @WithDocs() zu einem bestehenden Controller hinzu.
  4. Führ npx nestjs-docfy generate aus (oder erst --dry-run, um vorab zu sehen, was geschrieben würde), um die Datei *.controller.docs.ts neben dem Controller zu erzeugen, schon vorausgefüllt mit über docs() abgeleiteten Summaries und Responses, ohne die Logik des Controllers anzufassen.
  5. Bearbeite die generierte Datei, um alles Domänenspezifische zu ergänzen.
  6. Führ npx nestjs-docfy coverage aus, um den Fortschritt zu messen und zu iterieren.
  7. Wenn du zufrieden bist, aktivier DocfyModule.forRoot({ strict: true }), damit jeder ohne Docs-Datei markierte Controller beim Start scheitert.