docs(controllerClass, config)

Aplikuje dekoratory Swaggera do klasy kontrolera spoza jej pliku. Wywołaj to na najwyższym poziomie *.controller.docs.ts: wywołanie działa jako efekt uboczny przy imporcie.

Sygnatura

W pełni bezpieczne typowo: config.methods akceptuje wyłącznie klucze istniejące w klasie kontrolera.

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

config

  • classDecorators (ClassDecorator[]): aplikowane do konstruktora klasy.
  • methods (Partial<Record<keyof T, MethodDecorator[]>>): dekoratory per metoda, aplikowane w kolejności.
  • group (string): nazwa grupy dla x-tagGroups. Zobacz Tag groups.
  • tags (string[]): tagi powiązane z group. Muszą zgadzać się z ApiTags().

Jeśli klucz metody nie istnieje w kontrolerze w czasie działania, zapisywane jest ostrzeżenie, a ten wpis jest pomijany, ale reszta pliku docs jest nadal stosowana.