Changelog

Note di rilascio. Per la storia completa, vedi GitHub Releases su MarvinRF/nest-docfy.

Vedi GitHub Releases e CHANGELOG.md nel repository per la storia canonica, a livello di commit.

v0.9.0 (versione attuale)

  • Documenta specs, openApiDocument e additionalProxyOrigins in DocfyUiModule.setup(). specs esisteva già, non documentato, dalla v0.6.0; gli altri due sono il recupero documentazione di questa release per il proxy introdotto nella v0.8.0. Fissa la dipendenza docfy-ui a ^0.5.0.

v0.8.0

  • Proxy same-origin per il "Try it out" di docfy-ui, abilitato tramite le nuove opzioni openApiDocument/additionalProxyOrigins di DocfyUiModule.setup(). Evita del tutto CORS; i fallimenti a livello di proxy sono distinguibili da vere risposte API tramite un header di risposta X-Docfy-Proxy-Error.

v0.7.0

  • Nuovo comando CLI export: genera il documento OpenAPI dal tuo bootstrap senza richiedere .listen() o infrastruttura live.

v0.6.1 – v0.6.3

  • Inferisce lo schema completo per le entità di risposta prive di decorator class-validator.
  • Aggiornata la dipendenza fissata docfy-ui a ^0.3.0.
  • Collassa le union di letterali booleani in un semplice schema boolean.

v0.6.0

  • Bot di controllo PR: usa check/coverage contro l'app di esempio in CI (dogfooding).
  • Flag --json per check e coverage, per output leggibile da macchina.
  • Opzione specs per lo switcher multi-spec di docfy-ui.
  • --register-plugin corregge automaticamente webpack: true senza richiedere la configurazione manuale del plugin CLI.
  • Nuovo comando generate-client: un client TypeScript tipizzato generato da una spec OpenAPI.

v0.5.0

  • Prima release versionata tramite semantic-release/conventional commits. Consolida il tooling precedente sotto semver reale d'ora in poi. Nessuna nuova funzionalità visibile all'utente oltre a quanto già descritto sopra.

v0.4.0

  • DocfyUiModule ora funziona anche su app Fastify (@nestjs/platform-fastify), non solo Express. Richiede la dipendenza peer opzionale @fastify/static.
  • /api-json (staticSpecPath) e il fallback handler ora usano res.type()/res.send(), agnostici rispetto all'adapter, invece di API specifiche di Express.

v0.3.6

  • Corretta una condizione di export di default mancante nella mappa exports del pacchetto.

v0.3.5

  • Supporto al routing migliorato in DocfyUiModule; aggiornata la dipendenza companion docfy-ui alla 0.0.5.

v0.3.3 – v0.3.4

  • Release di manutenzione: aggiornata la dipendenza companion docfy-ui (a 0.0.3, poi 0.0.4). Nessun cambiamento funzionale a nestjs-docfy stesso.

v0.3.1 – v0.3.2

  • Release di manutenzione (solo metadati di lockfile/versione), nessun cambiamento funzionale.

v0.3.0

  • Introdotto DocfyUiModule: serve docfy-ui di default, con una modalità static-spec sicura anche sotto webpack.
  • Comando CLI patch-spec: patching OpenAPI basato solo su analisi statica.
  • Comando coverage per le metriche di documentazione, e comando lint per i controlli di qualità della documentazione.
  • Tag groups (x-tagGroups) per ReDoc.
  • Correzioni: merge dei tag case-sensitive che spezzava il gruppo nella sidebar, patch-spec che perdeva campi quando due controller applicavano patch alla stessa rotta, risoluzione della sorgente del controller via stack+source-map, falsi positivi negli avvisi di file docs mancante, e un crash su voci di require.cache con getter che sollevano eccezioni.
  • Documentazione: webpack: true documentato come fondamentalmente non supportato, con le motivazioni.

v0.2.8

  • Comando check, riconoscimento di @HttpCode(), e inferenza schema da class-validator.

v0.2.7

  • Rimossa la telemetria @scarf/scarf tramite un override di swagger-ui-dist; migliorata la struttura e la chiarezza del README.

v0.2.5 – v0.2.6

  • Output di ApiResponse più ricco, con descrizioni e risposte di errore (la v0.2.6 è stata una release di manutenzione senza ulteriori cambiamenti funzionali).

v0.2.4

  • Generazione di schema inline per i DTO tipizzati come interface.

v0.2.3

  • Output CLI completo: ApiParam/ApiBody/ApiQuery, riepiloghi inferiti, ApiBearerAuth, e modalità watch.

v0.2.2

  • Aggiunta l'inferenza del tipo di risposta DTO all'output di ApiResponse.

v0.2.1

  • generate ora produce decorator pronti all'uso invece di placeholder commentati.

v0.2.0

  • Il comando CLI nestjs-docfy generate, la prima funzionalità CLI.

v0.1.1 – v0.1.4

  • Prima release: la convenzione companion file @WithDocs()/docs() e DocfyModule.forRoot().
  • Chiavi di metodo type-safe in docs() tramite generics (v0.1.4).