DocfyModule.forRoot()

注册模块，并加载每个带 @WithDocs() 标记的控制器的 companion 文件。

导入模块

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

把 { strict: true } 传给 forRoot()，这样当某个控制器带 @WithDocs() 却找不到 companion 文件时，会在启动时直接快速失败（推荐在 CI 中使用）：

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

main.ts 保持不变

main.ts 无需改动

main.ts 不需要任何改动。DocfyModule 会在 SwaggerModule.createDocument() 被调用之前，就应用好所有元数据。