Controller mit @WithDocs() markieren

Markiere, welche Controller eine Companion-Datei haben, dann führe generate aus.

Controller markieren

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
}

Companion-Dateien generieren

Führ die CLI aus, um dein Projekt zu scannen und eine vorausgefüllte *.controller.docs.ts pro Controller zu erzeugen:

bash
npx nestjs-docfy generate

Die CLI nutzt ausschließlich statische Analyse (keine Codeausführung) und erkennt das Layout deines Projekts automatisch: Monorepos, Nx-Workspaces und Nest-CLI-Monorepos werden alle unterstützt.

Zum Vorschauen, ohne das Dateisystem anzufassen:

bash
npx nestjs-docfy generate --dry-run

Docs-Datei ausfüllen

Die generierte Datei ist bereits mit abgeleiteten Summaries, Response-Typen und gängigen Fehlerantworten vorausgefüllt:

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

Bearbeite die Datei frei: deine Änderungen sind sicher. Ein erneuter Lauf von generate überspringt vorhandene Dateien. Nutz --force, um nur neue Methoden einzufügen, ohne bestehende anzufassen.