docs(controllerClass, config)

Aplica decorators Swagger a uma classe de controller a partir de fora do arquivo dela. Chame no top-level do *.controller.docs.ts: a chamada roda como side effect no import.

Assinatura

Totalmente type-safe: config.methods só aceita chaves que existem na classe do controller.

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

config

  • classDecorators (ClassDecorator[]): aplicado ao construtor da classe.
  • methods (Partial<Record<keyof T, MethodDecorator[]>>): decorators por método, aplicados em ordem.
  • group (string): nome do grupo para x-tagGroups. Ver Tag groups.
  • tags (string[]): tags associadas ao group. Devem casar com ApiTags().

Se uma chave de método não existe no controller em runtime, um warning é logado e essa entrada é pulada, mas o resto do docs file ainda é aplicado.