Markeer controllers met @WithDocs()

Markeer welke controllers een companion-bestand hebben, en draai daarna generate.

Markeer je 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
}

Genereer de companion-bestanden

Draai de CLI om je project te scannen en een vooraf ingevuld *.controller.docs.ts per controller te genereren:

bash
npx nestjs-docfy generate

De CLI gebruikt alleen statische analyse (geen codeuitvoering) en herkent automatisch de layout van je project: monorepo's, Nx-workspaces en Nest CLI-monorepo's worden allemaal ondersteund.

Om te previewen zonder het bestandssysteem aan te raken:

bash
npx nestjs-docfy generate --dry-run

Vul het docsbestand in

Het gegenereerde bestand komt vooraf ingevuld met afgeleide summaries, responsetypes en gangbare foutresponses:

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" }),
    ],
  },
});

Bewerk het bestand vrij: je wijzigingen zijn veilig. generate opnieuw draaien slaat bestaande bestanden over. Gebruik --force om alleen nieuwe methoden samen te voegen zonder bestaande aan te raken.