docs(controllerClass, config)

Applica i decorator Swagger a una classe controller dall'esterno del suo file. Chiamalo al livello superiore di *.controller.docs.ts: la chiamata viene eseguita come effetto collaterale all'import.

Firma

Completamente type-safe: config.methods accetta solo chiavi che esistono sulla classe controller.

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

config

  • classDecorators (ClassDecorator[]): applicati al costruttore della classe.
  • methods (Partial<Record<keyof T, MethodDecorator[]>>): decorator per metodo, applicati in ordine.
  • group (string): nome del gruppo per x-tagGroups. Vedi Tag groups.
  • tags (string[]): tag associati al group. Devono corrispondere a ApiTags().

Se una chiave di metodo non esiste sul controller a runtime, viene loggato un avviso e quella voce viene saltata, ma il resto del file docs viene comunque applicato.