docs(controllerClass, config)

Применяет декораторы Swagger к классу контроллера снаружи его файла. Вызывайте на верхнем уровне *.controller.docs.ts: вызов отрабатывает побочным эффектом при импорте.

Сигнатура

Полная типобезопасность: config.methods принимает только те ключи, которые есть у класса контроллера.

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

config

  • classDecorators (ClassDecorator[]): применяются к конструктору класса.
  • methods (Partial<Record<keyof T, MethodDecorator[]>>): декораторы по методам, применяются по порядку.
  • group (string): название группы для x-tagGroups. См. Группы тегов.
  • tags (string[]): теги, привязанные к group. Должны совпадать с ApiTags().

Если в рантайме такого метода у контроллера нет, в лог уйдёт предупреждение, а сама запись будет пропущена. Остальная часть docs-файла всё равно применится.