@WithDocs() 与 DocfyRegistry

标记控制器参与 companion 文件发现的类装饰器,以及它留下的元数据标记。

装饰器

类装饰器,用于标记一个控制器参与 companion 文件发现机制,与 @Controller() 搭配使用。

ts
@WithDocs()
@Controller('products')
export class ProductsController { ... }

DOCFY_MARKER

同时会在类上设置 DOCFY_MARKER 元数据,供外部反射使用:

ts
import { DOCFY_MARKER } from "nestjs-docfy";

Reflect.getMetadata(DOCFY_MARKER, ProductsController); // true