Changelog

Release Notes. Die vollständige Historie findest du unter GitHub Releases bei MarvinRF/nest-docfy.

Die kanonische Historie auf Commit-Ebene findest du unter GitHub Releases und in CHANGELOG.md im Repository.

v0.9.0 (aktuelle Version)

  • Dokumentiert specs, openApiDocument und additionalProxyOrigins in DocfyUiModule.setup(). specs gab es seit v0.6.0 undokumentiert, die anderen beiden holen die Docs für das in v0.8.0 eingeführte Proxy nach. Pinnt die docfy-ui-Abhängigkeit auf ^0.5.0.

v0.8.0

  • Same-Origin-Proxy für „Try it out“ in docfy-ui, aktiviert über die neuen DocfyUiModule.setup()-Optionen openApiDocument/additionalProxyOrigins. Vermeidet CORS komplett; Fehler auf Proxy-Ebene lassen sich über einen X-Docfy-Proxy-Error-Response-Header von echten API-Antworten unterscheiden.

v0.7.0

  • Neuer export-CLI-Befehl: erzeugt das OpenAPI-Dokument aus deinem eigenen Bootstrap, ohne .listen() oder laufende Infrastruktur.

v0.6.1 – v0.6.3

  • Leitet das vollständige Schema für Response-Entities ohne class-validator-Decorators ab.
  • Die gepinnte docfy-ui-Abhängigkeit auf ^0.3.0 angehoben.
  • Fasst Boolean-Literal-Unions zu einem einfachen Boolean-Schema zusammen.

v0.6.0

  • PR-Check-Bot: nutzt check/coverage selbst gegen die Beispiel-App in CI.
  • --json-Flag für check und coverage, für maschinenlesbare Ausgabe.
  • specs-Option für den Multi-Spec-Umschalter von docfy-ui.
  • --register-plugin behebt webpack: true automatisch, ohne dass das CLI-Plugin von Hand konfiguriert werden muss.
  • Neuer generate-client-Befehl: ein typisierter TypeScript-Client, generiert aus einer OpenAPI-Spec.

v0.5.0

  • Erstes Release, versioniert über semantic-release/conventional commits. Bündelt bisheriges Tooling ab jetzt unter echtem Semver. Kein neues nutzersichtbares Feature über das bereits Beschriebene hinaus.

v0.4.0

  • DocfyUiModule funktioniert jetzt auch auf Fastify-Apps (@nestjs/platform-fastify), nicht nur auf Express. Braucht die optionale Peer-Dependency @fastify/static.
  • /api-json (staticSpecPath) und der Fallback-Handler nutzen jetzt die adapterunabhängigen res.type()/res.send() statt reiner Express-APIs.

v0.3.6

  • Eine fehlende Default-Export-Bedingung in der Exports-Map des Pakets wurde behoben.

v0.3.5

  • Verbesserte Routing-Unterstützung in DocfyUiModule; die docfy-ui-Begleitabhängigkeit auf 0.0.5 angehoben.

v0.3.3 – v0.3.4

  • Wartungs-Releases: die docfy-ui-Begleitabhängigkeit angehoben (auf 0.0.3, dann 0.0.4). Keine funktionalen Änderungen an nestjs-docfy selbst.

v0.3.1 – v0.3.2

  • Wartungs-Releases (nur Lockfile/Versions-Metadaten), keine funktionalen Änderungen.

v0.3.0

  • DocfyUiModule eingeführt: liefert standardmäßig docfy-ui aus, mit einem webpack-sicheren Static-Spec-Modus.
  • patch-spec-CLI-Befehl: OpenAPI-Patching nur per statischer Analyse.
  • coverage-Befehl für Dokumentationsmetriken und lint-Befehl für Qualitätsprüfungen der Dokumentation.
  • Tag-Gruppen (x-tagGroups) für ReDoc.
  • Fixes: case-sensitives Tag-Merging, das die Sidebar-Gruppe aufspaltete; patch-spec verlor Felder, wenn zwei Controller dieselbe Route patchten; Controller-Quellauflösung über Stack+Source-Map; false-positive Warnungen zu fehlenden Docs-Dateien; und ein Absturz bei require.cache-Einträgen mit werfenden Gettern.
  • Docs: webpack: true als grundsätzlich nicht unterstützt dokumentiert, mit Begründung.

v0.2.8

  • check-Befehl, @HttpCode()-Erkennung und Schema-Ableitung aus class-validator.

v0.2.7

  • @scarf/scarf-Telemetrie über einen swagger-ui-dist-Override entfernt; README-Struktur und -Klarheit verbessert.

v0.2.5 – v0.2.6

  • Reichhaltigere ApiResponse-Ausgabe, mit Beschreibungen und Fehlerantworten (v0.2.6 war ein Wartungs-Release ohne weitere funktionale Änderung).

v0.2.4

  • Inline-Schemagenerierung für interface-typisierte DTOs.

v0.2.3

  • Vollständige CLI-Ausgabe: ApiParam/ApiBody/ApiQuery, abgeleitete Summaries, ApiBearerAuth und Watch-Modus.

v0.2.2

  • DTO-Response-Typ-Ableitung zur ApiResponse-Ausgabe hinzugefügt.

v0.2.1

  • generate erzeugt jetzt einsatzbereite Decorators statt auskommentierter Platzhalter.

v0.2.0

  • Der CLI-Befehl nestjs-docfy generate, das erste CLI-Feature.

v0.1.1 – v0.1.4

  • Erstes Release: die Companion-File-Konvention @WithDocs()/docs() und DocfyModule.forRoot().
  • Typsichere Methoden-Keys in docs() über Generics (v0.1.4).