add swagger ui

package.json

@@ -24,13 +24,21 @@
     "@nestjs/common": "^7.5.1",
     "@nestjs/core": "^7.5.1",
     "@nestjs/platform-express": "^7.5.1",
+    "@nestjs/swagger": "^4.8.0",
+    "@nestjs/typeorm": "^7.1.5",
     "axios": "^0.21.1",
+    "class-transformer": "^0.4.0",
+    "class-validator": "^0.13.1",
+    "lodash": "^4.17.21",
     "md-to-pdf": "^3.3.2",
     "moment": "^2.29.1",
     "mustache": "^4.2.0",
+    "mysql": "^2.18.1",
     "reflect-metadata": "^0.1.13",
     "rimraf": "^3.0.2",
-    "rxjs": "^6.6.3"
+    "rxjs": "^6.6.3",
+    "swagger-ui-express": "^4.1.6",
+    "typeorm": "^0.2.32"
   },
   "devDependencies": {
     "@nestjs/cli": "^7.5.1",
@@ -38,6 +46,7 @@
     "@nestjs/testing": "^7.5.1",
     "@types/express": "^4.17.11",
     "@types/jest": "^26.0.15",
+    "@types/lodash": "^4.14.169",
     "@types/mustache": "^4.1.1",
     "@types/node": "^14.14.6",
     "@types/supertest": "^2.0.10",

src/app.controller.ts

@@ -13,12 +13,24 @@ import {
   CxcyReturnMessage,
   CxcyReturnMessageLike,
 } from './messages/CxcyReturnMessage';
+import {
+  ApiBadRequestResponse,
+  ApiHeader,
+  ApiInternalServerErrorResponse,
+  ApiOkResponse,
+  ApiQuery,
+} from '@nestjs/swagger';
 
 @Controller('api')
 export class AppController {
   constructor(private readonly appService: AppService) {}
 
   @Get('user/report.pdf')
+  @ApiHeader({ name: 'Authorization', description: '用户 token' })
+  @ApiQuery({ name: 'request_id', description: '请求 id，直接返回。' })
+  @ApiOkResponse({ description: '成功，会直接提供文件下载。' })
+  @ApiBadRequestResponse({ description: '用户不存在或者没有登录。' })
+  @ApiInternalServerErrorResponse({ description: '报告生成过程中出现问题。' })
   async getPdf(
     @Headers('Authorization') userToken: string,
     @Query('request_id') requestId: string,

src/app.service.ts

@@ -71,7 +71,7 @@ export class AppService {
       {
         // eslint-disable-next-line @typescript-eslint/ban-ts-comment
         // @ts-ignore
-        launch_options: { args: ['--no-sandbox', '--disable-setuid-sandbox'] },
+        launch_options: { args: ['--no-sandbox'] },
       },
     );
     return content;

src/main.ts

 import { NestFactory } from '@nestjs/core';
 import { AppModule } from './app.module';
+import { DocumentBuilder, SwaggerModule } from '@nestjs/swagger';
 
 async function bootstrap() {
   const app = await NestFactory.create(AppModule);
   app.enableCors();
+
+  const documentConfig = new DocumentBuilder()
+    .setTitle('cxcy-scoresheet')
+    .setDescription('创新创业报告生成模块')
+    .setVersion('1.0')
+    .build();
+
+  const document = SwaggerModule.createDocument(app, documentConfig);
+  SwaggerModule.setup('docs', app, document);
+
   await app.listen(3000);
 }
 bootstrap();