docs(controllerClass, config)

Aplica decorators de Swagger a una clase controller desde fuera de su archivo. Llámalo en el nivel superior de *.controller.docs.ts: la llamada se ejecuta como efecto secundario al importar.

Firma

Completamente type-safe: config.methods solo acepta claves que existen en la clase controller.

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

config

  • classDecorators (ClassDecorator[]): aplicado al constructor de la clase.
  • methods (Partial<Record<keyof T, MethodDecorator[]>>): decorators por método, aplicados en orden.
  • group (string): nombre del grupo para x-tagGroups. Consulta Grupos de tags.
  • tags (string[]): tags asociados al group. Deben coincidir con ApiTags().

Si una clave de método no existe en el controller en runtime, se registra un aviso y esa entrada se omite, pero el resto del docs file se sigue aplicando.