Marca los controllers con @WithDocs()

Marca qué controllers tienen un archivo companion, y luego ejecuta generate.

Marca tus controllers

users.controller.ts
// users.controller.ts
import { Controller, Get, Post, Body } from "@nestjs/common";
import { WithDocs } from "nestjs-docfy";

@WithDocs()
@Controller("users")
export class UsersController {
  // route handlers only: no Swagger decorators here
}

Genera los archivos companion

Ejecuta el CLI para escanear tu proyecto y generar un *.controller.docs.ts prerellenado para cada controller:

bash
npx nestjs-docfy generate

El CLI usa solo análisis estático (sin ejecución de código) y detecta automáticamente el layout de tu proyecto: monorepos, workspaces de Nx, y monorepos del Nest CLI están todos soportados.

Para previsualizar sin tocar el filesystem:

bash
npx nestjs-docfy generate --dry-run

Rellena el docs file

El archivo generado viene prerellenado con summaries inferidos, tipos de respuesta, y respuestas de error comunes:

users.controller.docs.ts
// Generated by nestjs-docfy: edit freely, use --force to merge new methods
import { docs } from "nestjs-docfy";
import { ApiTags, ApiOperation, ApiResponse, ApiBody } from "@nestjs/swagger";
import { UsersController } from "./users.controller";
import { CreateUserDto } from "./dto/create-user.dto";
import { UserEntity } from "./entities/user.entity";

docs(UsersController, {
  classDecorators: [ApiTags("users")],
  methods: {
    // GET / → async findAll(): Promise<UserEntity[]>
    findAll: [
      ApiOperation({ summary: "Find all" }),
      ApiResponse({ status: 200, description: "OK", type: [UserEntity] }),
    ],

    // POST / → async create(dto: CreateUserDto): Promise<UserEntity>
    create: [
      ApiOperation({ summary: "Create" }),
      ApiBody({ type: CreateUserDto }),
      ApiResponse({ status: 201, description: "Created", type: UserEntity }),
      ApiResponse({ status: 400, description: "Bad Request" }),
    ],
  },
});

Edita el archivo libremente: tus cambios están a salvo. Ejecutar generate de nuevo se salta los archivos existentes. Usa --force para fusionar solo los métodos nuevos sin tocar los existentes.