这一节， 我们引入 Swagger 来自动根据代码里的注脚来生成接口文档。
Nest 为我们提供了一个专用的模块来搭配 Swagger 来使用
1. 安装依赖
1
| yarn add @nestjs/swagger swagger-ui-express
|
2. 初始化 Swagger 模块
在我们的应用入口文件 main.ts 中添加一个 createSwagger 方法， 并在 bootstrap 方法中初始化它
main.ts1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
| import { INestApplication, ValidationPipe } from '@nestjs/common'
import { NestFactory } from '@nestjs/core'
import { DocumentBuilder, SwaggerModule } from '@nestjs/swagger'
import { AppModule } from 'app.module'
function createSwagger(app: INestApplication) {
const version = require('../package.json').version || ''
const options = new DocumentBuilder()
.setTitle('Nestjs Realworld Example App')
.setVersion(version)
.addBearerAuth()
.build()
const document = SwaggerModule.createDocument(app, options)
SwaggerModule.setup('/docs', app, document)
}
async function bootstrap() {
const app = await NestFactory.create(AppModule)
app.useGlobalPipes(new ValidationPipe())
if (process.env.SWAGGER_ENABLE && process.env.SWAGGER_ENABLE === 'true') {
createSwagger(app)
}
await app.listen(3000)
}
bootstrap().catch((err) => console.error(err))
|
在 createSwagger 中， 我们首先读取了来自 package.json 中的版本号来作为接口的版本
然后我们设置了 Title 和 Bearer 鉴权认证入口， 我们还设置了 /docs 为我们文档的入口
最后，我们判断环境变量中的 SWAGGER_ENABLE 是否打开， 如果打开我们就初始化 Swagger 文档系统。
在 .env 和 .env.template 中增加 SWAGGER_ENABLE=true, 然后启动服务器
访问 http://localhost:3000/docs 就能看见我们的接口文档创建好啦！
小半年前，项目规模越来越大，随着十几轮冲刺后，我们有两个前端库的代码量和测试也越来越多，于是出现了上面的对话
