Changelog

Release notes. For the full history, see GitHub Releases at MarvinRF/nest-docfy.

See GitHub Releases and CHANGELOG.md in the repository for the canonical, commit-level history.

v0.9.0 (current version)

  • Documents specs, openApiDocument, and additionalProxyOrigins in DocfyUiModule.setup(). specs had existed undocumented since v0.6.0; the other two are this release's docs catch-up for the proxy introduced in v0.8.0. Pins the docfy-ui dependency to ^0.5.0.

v0.8.0

  • Same-origin proxy for docfy-ui's "Try it out", enabled via new DocfyUiModule.setup() options openApiDocument/additionalProxyOrigins. Avoids CORS entirely; proxy-level failures are distinguishable from real API responses via an X-Docfy-Proxy-Error response header.

v0.7.0

  • New export CLI command: generates the OpenAPI document from your own bootstrap without requiring .listen() or live infrastructure.

v0.6.1 – v0.6.3

  • Infer the full schema for response entities that have no class-validator decorators.
  • Bumped the pinned docfy-ui dependency to ^0.3.0.
  • Collapse boolean literal unions to a plain boolean schema.

v0.6.0

  • PR-check bot: dogfoods check/coverage against the example app in CI.
  • --json flag for check and coverage, for machine-readable output.
  • specs option for docfy-ui's multi-spec switcher.
  • --register-plugin auto-fixes webpack: true without requiring the CLI plugin to be configured by hand.
  • New generate-client command: a typed TypeScript client generated from an OpenAPI spec.

v0.5.0

  • First release versioned via semantic-release/conventional commits. Consolidates prior tooling under real semver going forward. No new user-facing feature beyond what's already described above.

v0.4.0

  • DocfyUiModule now works on Fastify apps (@nestjs/platform-fastify), not just Express. Needs the optional peer dependency @fastify/static.
  • /api-json (staticSpecPath) and the fallback handler now use the adapter-agnostic res.type()/res.send() instead of Express-only APIs.

v0.3.6

  • Fixed a missing default export condition in the package's exports map.

v0.3.5

  • Enhanced routing support in DocfyUiModule; bumped the docfy-ui companion dependency to 0.0.5.

v0.3.3 – v0.3.4

  • Housekeeping releases: bumped the docfy-ui companion dependency (to 0.0.3, then 0.0.4). No functional changes to nestjs-docfy itself.

v0.3.1 – v0.3.2

  • Housekeeping releases (lockfile/version metadata only), no functional changes.

v0.3.0

  • DocfyUiModule introduced: serves docfy-ui by default, with a webpack-safe static-spec mode.
  • patch-spec CLI command: static-analysis-only OpenAPI patching.
  • coverage command for documentation metrics, and lint command for documentation quality checks.
  • Tag groups (x-tagGroups) for ReDoc.
  • Fixes: case-sensitive tag merging that split the sidebar group, patch-spec losing fields when two controllers patched the same route, controller source resolution via stack+source-map, false-positive missing-docs-file warnings, and a crash on require.cache entries with throwing getters.
  • Docs: webpack: true documented as fundamentally unsupported, with why.

v0.2.8

  • check command, @HttpCode() awareness, and class-validator schema inference.

v0.2.7

  • Removed @scarf/scarf telemetry via a swagger-ui-dist override; README structure and clarity improvements.

v0.2.5 – v0.2.6

  • Richer ApiResponse output, with descriptions and error responses (v0.2.6 was a housekeeping release with no further functional change).

v0.2.4

  • Inline schema generation for interface-typed DTOs.

v0.2.3

  • Complete CLI output: ApiParam/ApiBody/ApiQuery, inferred summaries, ApiBearerAuth, and watch mode.

v0.2.2

  • DTO response type inference added to ApiResponse output.

v0.2.1

  • generate now produces ready-to-use decorators instead of commented placeholders.

v0.2.0

  • The nestjs-docfy generate CLI command, the first CLI feature.

v0.1.1 – v0.1.4

  • Initial release: the @WithDocs()/docs() companion-file convention and DocfyModule.forRoot().
  • Type-safe method keys in docs() via generics (v0.1.4).