前言
前几天在项目中集成了swagger，一切准备就绪打算将其部署到服务器时发现并不顺利，访问的时候页面白屏，由于我的nest项目采用的是单文件部署，互联网上没有找到相关的解决方案，于是我就成了第一个吃螃蟹的人。
经过一番折腾后，终于解决了这个问题，本文就跟大家分享下我的解决方案，欢迎各位感兴趣的开发者阅读本文。
集成Swagger
首先，我们通过yarn安装三个依赖包，如下所示：
yarn add @nestjs/swagger swagger-ui-express fastify-swagger
安装完成后，我们打开项目的入口文件main.ts添加如下所示的代码：
import { DocumentBuilder, SwaggerModule } from "@nestjs/swagger";
async function bootstrap() {
// **** 其它代码省略 ****
const config = new DocumentBuilder()
.setTitle("nest-demo")
.setDescription("nest-demo项目的API使用文档")
.setVersion("1.0.0")
.build();
const document = SwaggerModule.createDocument(app, config);
SwaggerModule.setup("api", app, document);
}
接下来，我们启动项目，在浏览器访问http://127.0.0.1:3000/api，显示的界面如下所示：
default选项列出了我们项目中的所有接口
image-20220317211550995
通过注解编写接口文档
在@nestjs/swagger库中，它提供了丰富的依赖供我们使用， 为我们生成友好的接口文档，接下来我们列举几个较为常用的注解：
@ApiTags注解，用于对controller层进行描述。@ApiOperation注解，用于对controller中的具体接口进行描述。@ApiProperty注解，用于对dto层的参数进行描述。@ApiResponse注解，用于对接口的返回数据进行描述。
关于上述各个注解的具体使用方法可参考我的项目代码，如下所示：
- AppController.ts[1]
- AppDto.ts[2]
- ResultVO[3]
经过上述配置后 ，最终访问效果如下所示：
image-20220317224923516
❝有关swagger注解的更多使用方法请移步：OpenAPI (Swagger)[4]
部署至服务器
接下来，我们要做的就是将项目打包部署到服务器了，本项目采用的是单文件构建法，对此不了解的开发者请移步：Nest项目部署的最佳方式[5]。
构建时遇到的问题
因为集成了swagger进来，在打包时终端报错了ERROR in ./node_modules/@nestjs/mapped-types/dist/type-helpers.utils.js 69:27-63 Module not found: Error: Can't resolve 'class-transformer/storage' in ...
经过一番查找后，在mapped-types仓库的Issues[6]中找到了答案，需要在webpack.config.js中的lazyImports中加入class-transformer/storage，打包的时候即可将其忽略，部分代码如下所示，完整代码请移步：
module.exports = {
entry: "./src/main",
target: "node",
// ** 其他配置代码省略 **
plugins: [
// 需要进行忽略的插件
new webpack.IgnorePlugin({
checkResource(resource) {
const lazyImports = [
"@nestjs/microservices",
"@nestjs/microservices/microservices-module",
"@nestjs/websockets/socket-module",
"cache-manager",
"class-validator",
"class-transformer",
"class-transformer/storage"
];
})
}
❝完整代码请移步：webpack.config.js[7]
部署时遇到的问题
我们将项目部署到服务器，启动后，在浏览器通过127.0.0.1：3000/api访问swagger时发现页面一片空白，打开控制台后发现它的一些资源文件404了。
image-20220318072947623
这可真是个棘手的问题，直觉告诉我肯定是因为我配置了单文件部署才导致的，我在求助了很多人，查了很多资料后，发现他们都没像我这么玩过，他们都是在服务器上npm install依赖来跑nest项目的。
真是糟了个大糕
