Historia zmian

Notatki wydań. Pełną historię znajdziesz w GitHub Releases pod MarvinRF/nest-docfy.

Kanoniczną historię, na poziomie commitów, znajdziesz w GitHub Releases oraz w pliku CHANGELOG.md repozytorium.

v0.9.0 (aktualna wersja)

  • Dokumentuje specs, openApiDocument i additionalProxyOrigins w DocfyUiModule.setup(). specs istniało nieudokumentowane od v0.6.0; pozostałe dwa to uzupełnienie dokumentacji tego wydania dla proxy wprowadzonego w v0.8.0. Przypina zależność docfy-ui do ^0.5.0.

v0.8.0

  • Proxy w ramach tego samego origin dla „Try it out” w docfy-ui, włączane nowymi opcjami DocfyUiModule.setup(): openApiDocument/additionalProxyOrigins. Całkowicie omija CORS; awarie na poziomie proxy można odróżnić od prawdziwych odpowiedzi API dzięki nagłówkowi odpowiedzi X-Docfy-Proxy-Error.

v0.7.0

  • Nowa komenda CLI export: generuje dokument OpenAPI z Twojego własnego bootstrapu bez wymagania .listen() ani żywej infrastruktury.

v0.6.1 – v0.6.3

  • Wnioskuje pełny schemat dla encji odpowiedzi bez dekoratorów class-validator.
  • Podniesiona przypięta zależność docfy-ui do ^0.3.0.
  • Zwija unie literałów boolowskich do zwykłego schematu boolean.

v0.6.0

  • Bot sprawdzający PR: używa check/coverage na przykładowej aplikacji w CI, jedząc własny suchy chleb.
  • Flaga --json dla check i coverage, do wyniku odczytywalnego maszynowo.
  • Opcja specs dla przełącznika wielu specyfikacji w docfy-ui.
  • --register-plugin naprawia automatycznie webpack: true bez ręcznej konfiguracji pluginu CLI.
  • Nowa komenda generate-client: typowany klient TypeScript generowany ze specyfikacji OpenAPI.

v0.5.0

  • Pierwsze wydanie wersjonowane przez semantic-release/conventional commits. Konsoliduje dotychczasowe narzędzia pod prawdziwym semver na przyszłość. Żadnej nowej funkcji widocznej dla użytkownika ponad to, co już opisano wyżej.

v0.4.0

  • DocfyUiModule działa teraz na aplikacjach Fastify (@nestjs/platform-fastify), nie tylko Express. Wymaga opcjonalnej zależności peer @fastify/static.
  • /api-json (staticSpecPath) oraz handler fallback używają teraz niezależnych od adaptera res.type()/res.send() zamiast API dostępnych tylko w Express.

v0.3.6

  • Naprawiono brakujący warunek eksportu domyślnego w mapie exports pakietu.

v0.3.5

  • Ulepszona obsługa routingu w DocfyUiModule; podniesiona zależność towarzysząca docfy-ui do 0.0.5.

v0.3.3 – v0.3.4

  • Wydania porządkowe: podniesiona zależność towarzysząca docfy-ui (do 0.0.3, potem 0.0.4). Żadnych zmian funkcjonalnych w samym nestjs-docfy.

v0.3.1 – v0.3.2

  • Wydania porządkowe (tylko metadane lockfile/wersji), bez zmian funkcjonalnych.

v0.3.0

  • Wprowadzono DocfyUiModule: domyślnie serwuje docfy-ui, z trybem statycznej specyfikacji bezpiecznym dla webpacka.
  • Komenda CLI patch-spec: łatanie OpenAPI wyłącznie przez analizę statyczną.
  • Komenda coverage dla metryk dokumentacji oraz lint do sprawdzania jej jakości.
  • Grupy tagów (x-tagGroups) dla ReDoc.
  • Poprawki: scalanie tagów uwzględniające wielkość liter, które dzieliło grupę w panelu bocznym, patch-spec tracący pola, gdy dwa kontrolery łatały tę samą trasę, rozwiązywanie źródła kontrolera przez stack + source-map, fałszywie pozytywne ostrzeżenia o brakującym pliku docs, oraz awaria na wpisach require.cache z rzucającymi getterami.
  • Dokumentacja: webpack: true udokumentowane jako fundamentalnie nieobsługiwane, wraz z powodem.

v0.2.8

  • Komenda check, obsługa @HttpCode() oraz wnioskowanie schematu z class-validator.

v0.2.7

  • Usunięto telemetrię @scarf/scarf przez override swagger-ui-dist; poprawki struktury i czytelności README.

v0.2.5 – v0.2.6

  • Bogatszy wynik ApiResponse, z opisami i odpowiedziami błędów (v0.2.6 było wydaniem porządkowym bez dalszych zmian funkcjonalnych).

v0.2.4

  • Generowanie schematu inline dla DTO typowanych interfejsami.

v0.2.3

  • Kompletny wynik CLI: ApiParam/ApiBody/ApiQuery, wnioskowane podsumowania, ApiBearerAuth i tryb watch.

v0.2.2

  • Dodano wnioskowanie typu odpowiedzi DTO do wyniku ApiResponse.

v0.2.1

  • generate generuje teraz gotowe do użycia dekoratory zamiast zakomentowanych placeholderów.

v0.2.0

  • Komenda CLI nestjs-docfy generate, pierwsza funkcja CLI.

v0.1.1 – v0.1.4

  • Pierwsze wydanie: konwencja pliku towarzyszącego @WithDocs()/docs() oraz DocfyModule.forRoot().
  • Bezpieczne typowo klucze metod w docs() przez generyki (v0.1.4).