docs(controllerClass, config)

从控制器文件之外,为该控制器类应用 Swagger 装饰器。在 *.controller.docs.ts 的顶层调用它,这个调用会在导入时作为副作用执行。

签名

完全类型安全:config.methods 只接受控制器类上真实存在的方法名。

ts
docs(UsersController, {
  classDecorators: [ApiTags('users')],
  methods: {
    findAll: [...],    // ✔ exists on UsersController
    typoMethod: [...], // ✖ TypeScript error
  },
});

config

  • classDecorators (ClassDecorator[]): 应用到类构造函数上。
  • methods (Partial<Record<keyof T, MethodDecorator[]>>): 按方法名分类的装饰器,按顺序应用。
  • group (string): 用于 x-tagGroups 的分组名。见 标签分组
  • tags (string[]): group 关联的标签,需要和 ApiTags() 保持一致。

如果某个方法名在运行时的控制器上不存在,会记录一条警告并跳过该条目,但 docs 文件的其余部分照常应用。