安装依赖

    1. yarn add @nestjs/swagger swagger-ui-express --save

    配置

    1. import { NestFactory } from '@nestjs/core';
    2. import { AppModule } from './app.module';
    3. import { DocumentBuilder,SwaggerModule} from '@nestjs/swagger'
    4. async function bootstrap() {
    5.   const app = await NestFactory.create(AppModule);
    6.   const swaggerOptions = new DocumentBuilder()
    7.   .setTitle('文档标题')
    8.   .setDescription('描述信息')
    9.   .setVersion('0.0.1')
    10.   .addBasicAuth() //  鉴权？ 
    11.   .build()
    12.   //  创建文档到app服务上 
    13.   const document = SwaggerModule.createDocument(app,swaggerOptions)
    14.   //  创建访问的路径
    15.   SwaggerModule.setup('docs',app,document)
    16.   await app.listen(3000);
    17. }
    18. bootstrap();

    使用

    1. import { Body, Controller, Delete, Get, Param, Post, Put, Query } from '@nestjs/common';
    2. import { ApiBody, ApiParam, ApiQuery, ApiResponse } from '@nestjs/swagger'
    4. @Controller('template')
    5. export class TemplateController {
    6.     /**
    7.      * get 请求
    8.      * localhost:3000/template/?name=123&age=234
    9.      */
    10.     @ApiQuery({ name: 'name', required: true })
    11.     @ApiQuery({ name: 'role', })
    12.     @ApiResponse({
    13.         status: 200,
    14.         description: "reqeeust ok",
    15.     })
    16.     @Get()
    17.     get(@Query() query): object {
    18.         return query
    19.     }
    22.     /**
    23.      * post 请求
    24.      * localhost:3000/template/
    25.      * {
    26.      *    "name":123,
    27.      *    "age":345
    28.      * }
    29.      */
    30.     @ApiBody({ description: "请填写内容" })
    31.     @Post()
    32.     post(@Body() body): object {
    33.         return body
    34.     }
    36.     /**
    37.      * put 请求
    38.      * localhost:3000/template/123
    39.      * name在x-www-form-urlencoded 中传
    40.      */
    41.     @ApiParam({ name: "id" })
    42.     @ApiBody({ description: "请输入id" })
    43.     @Put(":id")
    44.     put(@Param() { id }, @Body() { name }): string {
    45.         return `put id is ${id} - ${name}`
    46.     }
    48.     /**
    49.      * delete 请求
    50.      * localhost:3000/template/?id=123
    51.      */
    52.     @Delete()
    53.     @ApiQuery({ name: 'id', required: true })
    54.     delete(@Query() { id }): string {
    55.         return `del ${id}`
    56.     }
    57. }

    访问上面定义好的 http://localhost:3000/docs 就可以看到