DocfyModule.forRoot()

モジュールを登録し、@WithDocs()が付いたすべてのコントローラーのコンパニオンファイルを読み込みます。

モジュールをインポートする

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

@WithDocs()が付いているのにコンパニオンファイルが見つからないコントローラーがある場合に起動時に早期失敗させるには、{ strict: true }を渡してください(CI推奨)。

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

main.tsは変更不要

main.tsの変更は不要

main.tsへの変更は一切不要です。DocfyModuleはSwaggerModule.createDocument()が呼び出される前に、すべてのメタデータを適用します。