DocfyModule.forRoot()

Registreert de module en laadt elk companion-bestand voor controllers gemarkeerd met @WithDocs().

De module importeren

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

Geef { strict: true } mee om bij het opstarten meteen te falen wanneer een controller @WithDocs() heeft maar geen companion-bestand gevonden wordt (aanbevolen voor CI):

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

main.ts blijft ongewijzigd

Geen wijzigingen aan main.ts

Er zijn geen wijzigingen aan main.ts nodig. DocfyModule past alle metadata toe voordat SwaggerModule.createDocument() aangeroepen wordt.