docs(controllerClass, config)

Past Swagger-decorators toe op een controllerklasse vanaf buiten het bestand ervan, als side effect bij het importeren.

Signatuur

Roep dit aan op het top-level van een *.controller.docs.ts-bestand, waar het als side effect meeloopt bij het importeren.

Type-safety

Volledig type-safe: config.methods accepteert alleen keys die op de controllerklasse bestaan. Typefouten worden bij compile time gevangen.

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

Configuratievelden

  • config.classDecorators: ClassDecorator[], toegepast op de class constructor (bijv. ApiTags, ApiBearerAuth).
  • config.methods: Partial<Record<keyof T, MethodDecorator[]>>, decoratorarrays gekeyed op methodenaam, toegepast in volgorde.
  • config.group: string, logische groepsnaam voor de x-tagGroups-extensie van ReDoc.
  • config.tags: string[], tagnamen gekoppeld aan de group. Moet overeenkomen met wat je meegeeft aan ApiTags().

Runtime-gedrag

Niet-bestaande methode-key

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.