docs(controllerClass, config)

Past Swagger-decorators toe op een controllerklasse vanaf buiten het bestand ervan. Roep dit aan op het top-level van *.controller.docs.ts: de call loopt als side effect mee bij het importeren.

Signatuur

Volledig type-safe: config.methods accepteert alleen keys die daadwerkelijk op de controllerklasse bestaan.

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

config

  • classDecorators (ClassDecorator[]): toegepast op de class constructor.
  • methods (Partial<Record<keyof T, MethodDecorator[]>>): decorators per methode, toegepast in volgorde.
  • group (string): groepsnaam voor x-tagGroups. Zie Tag groups.
  • tags (string[]): tags gekoppeld aan de group. Moet overeenkomen met ApiTags().

Bestaat een methode-key niet op de controller ten tijde van runtime, dan wordt een waarschuwing gelogd en die entry overgeslagen, maar de rest van het docsbestand wordt gewoon toegepast.