DocfyModule.forRoot()

Rejestruje moduł i wczytuje każdy plik towarzyszący dla kontrolerów oznaczonych @WithDocs().

Zaimportuj moduł

app.module.ts
// app.module.ts
import { Module } from "@nestjs/common";
import { DocfyModule } from "nestjs-docfy";

@Module({
  imports: [DocfyModule.forRoot()],
})
export class AppModule {}

strict: true

Przekaż { strict: true }, aby szybko zawieść przy starcie, gdy kontroler ma @WithDocs(), ale żaden plik towarzyszący nie zostanie znaleziony (rekomendowane dla CI):

ts
DocfyModule.forRoot({ strict: true });

main.ts bez zmian

Żadnych zmian w main.ts

Żadne zmiany w main.ts nie są potrzebne. DocfyModule aplikuje wszystkie metadane, zanim wywołane zostanie SwaggerModule.createDocument().