docs(controllerClass, config)

Applique des décorateurs Swagger à une classe de contrôleur depuis l'extérieur de son fichier. Appelle-la au premier niveau de *.controller.docs.ts : l'appel s'exécute comme effet de bord à l'import.

Signature

Entièrement type-safe : config.methods n'accepte que les clés qui existent sur la classe du contrôleur.

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

config

  • classDecorators (ClassDecorator[]): appliqués au constructeur de la classe.
  • methods (Partial<Record<keyof T, MethodDecorator[]>>): décorateurs par méthode, appliqués dans l'ordre.
  • group (string): nom du groupe pour x-tagGroups. Voir Groupes de tags.
  • tags (string[]): tags associés au group. Doivent correspondre à ApiTags().

Si une clé de méthode n'existe pas sur le contrôleur à l'exécution, un avertissement est enregistré et cette entrée est ignorée, mais le reste du fichier docs est quand même appliqué.