docs(controllerClass, config)

Wendet Swagger-Decorators auf eine Controller-Klasse an, außerhalb ihrer eigenen Datei. Rufe es auf oberster Ebene von *.controller.docs.ts auf: Der Aufruf läuft als Seiteneffekt beim Import.

Signatur

Vollständig typsicher: config.methods akzeptiert nur Keys, die auf der Controller-Klasse existieren.

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

config

  • classDecorators (ClassDecorator[]): wird auf den Klassenkonstruktor angewendet.
  • methods (Partial<Record<keyof T, MethodDecorator[]>>): Decorators pro Methode, in Reihenfolge angewendet.
  • group (string): Gruppenname für x-tagGroups. Siehe Tag groups.
  • tags (string[]): Tags, die mit group verknüpft sind. Müssen zu ApiTags() passen.

Existiert ein Methoden-Key zur Laufzeit nicht auf dem Controller, wird eine Warnung geloggt und dieser Eintrag übersprungen – der Rest der Docs-Datei wird trotzdem angewendet.