为已有 API 补充文档

步骤

1. 安装这个包（见安装）。
2. 在你的 AppModule 中注册 DocfyModule.forRoot()。
   app.module.ts

   // app.module.ts
   import { Module } from '@nestjs/common';
   import { DocfyModule } from 'nestjs-docfy';
   
   @Module({
     imports: [DocfyModule.forRoot()],
   })
   export class AppModule {}

3. 给一个已有的控制器加上 @WithDocs()。
   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
   }

4. 运行 npx nestjs-docfy generate（或者先加 --dry-run 预览会写出什么），在控制器旁边生成 *.controller.docs.ts 文件，通过 docs() 预先填充好推断出的 summary 和响应，不改动控制器本身的逻辑。
   bash

   npx nestjs-docfy generate --dry-run
   npx nestjs-docfy generate

   users.controller.docs.ts (generated)

   // Generated by nestjs-docfy@x.y.z. Edit freely, use --force to merge new methods, --overwrite to regenerate from scratch
   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' }),
       ],
     },
   });

5. 编辑生成的文件，补上和你业务相关的内容。
6. 运行 npx nestjs-docfy coverage 来衡量进度并持续迭代。
   bash

   npx nestjs-docfy coverage

   text

   Controllers: 42
   Endpoints: 187
   
   Documented: 174
   Missing docs: 13
   
   Coverage: 93.0%

7. 满意之后，开启 DocfyModule.forRoot({ strict: true })，这样任何没有 docs 文件的标记控制器都会在启动时失败。
   ts

   DocfyModule.forRoot({ strict: true });