Marque tes contrôleurs avec @WithDocs()

Indique quels contrôleurs ont un fichier compagnon, puis lance generate.

Marque tes contrôleurs

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
}

Génère les fichiers compagnons

Lance le CLI pour scanner ton projet et générer un *.controller.docs.ts pré-rempli pour chaque contrôleur :

bash

npx nestjs-docfy generate

Le CLI utilise uniquement l'analyse statique (aucune exécution de code) et détecte automatiquement la structure de ton projet : monorepos, workspaces Nx, et monorepos Nest CLI sont tous supportés.

Pour prévisualiser sans toucher au système de fichiers :

bash

npx nestjs-docfy generate --dry-run

Remplis le fichier docs

Le fichier généré arrive pré-rempli avec des résumés inférés, des types de réponse, et des réponses d'erreur courantes :

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

Modifie le fichier librement : tes changements sont préservés. Relancer generate saute les fichiers existants. Utilise --force pour ne fusionner que les nouvelles méthodes sans toucher aux existantes.

Sur cette page