使用swagger自动生成接口文档

前言

俗话说: 工欲善其事必先利其器，由于前后端分离开发模式中，使用swagger自动生成接口文档；更便于前后端人员开发与沟通，同时更好的测试与维护Api文档

安装

npm install --save @nestjs/swagger swagger-ui-express

在main.ts 注册swagger

import { NestFactory } from '@nestjs/core';
import {SwaggerModule,DocumentBuilder} from "@nestjs/swagger"
import { AppModule } from './app.module';

async function bootstrap() {
  const app = await NestFactory.create(AppModule);
  const swaggerOptions=new DocumentBuilder().setTitle("nest_vhen_blog接口文档").setDescription("描述...").setVersion("1.0").build();
  const swaggerDoc=SwaggerModule.createDocument(app,swaggerOptions);
  SwaggerModule.setup('/api-docs',app,swaggerDoc);
  await app.listen(3000);
}
bootstrap();