Oznacz kontrolery @WithDocs()

Oznacz, które kontrolery mają plik towarzyszący, a potem uruchom generate.

Oznacz swoje kontrolery

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
}

Wygeneruj pliki towarzyszące

Uruchom CLI, aby przeskanować projekt i wygenerować wstępnie wypełniony *.controller.docs.ts dla każdego kontrolera:

bash
npx nestjs-docfy generate

CLI używa wyłącznie analizy statycznej (bez wykonywania kodu) i automatycznie wykrywa układ Twojego projektu: obsługiwane są monorepo, workspace'y Nx oraz monorepo Nest CLI.

Aby zobaczyć podgląd bez dotykania systemu plików:

bash
npx nestjs-docfy generate --dry-run

Uzupełnij plik docs

Wygenerowany plik jest wstępnie wypełniony wnioskowanymi podsumowaniami, typami odpowiedzi i typowymi odpowiedziami błędów:

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

Edytuj plik swobodnie: Twoje zmiany są bezpieczne. Ponowne uruchomienie generate pomija istniejące pliki. Użyj --force, aby scalić tylko nowe metody, bez dotykania istniejących.