Typescript 是否可以添加身份验证以访问 NestJS 的 Swagger Explorer

发布于06月02日

我目前正在NestJS项目中使用Swagger，并且启用了浏览器:

main.js年后

const options = new DocumentBuilder()
    .setTitle('My App')
    .setSchemes('https')
    .setDescription('My App API documentation')
    .setVersion('1.0')
    .build()

const document = SwaggerModule.createDocument(app, options)
SwaggerModule.setup('docs', app, document, {
    customSiteTitle: 'My App documentation',
})

有了这个，探险者可以在/docs分钟内进入，这是我所期望的.但是我想知道是否可以在浏览器中添加任何身份验证层，这样只接受某些请求.

我想让这个资源管理器在生产环境中可以访问，但仅限于经过身份验证的用户.

提前感谢:)

推荐答案

Securing access to your Swagger with HTTP Basic Auth using NestJS with Express

首先运行npm i express-basic-auth，然后将以下内容添加到main.{ts,js}:

// add import
import * as basicAuth from 'express-basic-auth';

// ...

// Sometime after NestFactory add this to add HTTP Basic Auth
app.use(
    ['/docs', '/docs-json'],
    basicAuth({
        challenge: true,
        users: {
            yourUserName: 'p4ssw0rd',
        },
    }),
);


// Your code
const options = new DocumentBuilder()
    .setTitle('My App')
    .setSchemes('https')
    .setDescription('My App API documentation')
    .setVersion('1.0')
    .build()

const document = SwaggerModule.createDocument(app, options)
SwaggerModule.setup('docs', app, document, {
    customSiteTitle: 'My App documentation',
})

// ...

有了这个选项，您将在/docs条路由中的任何一条上收到HTTP Basic Auth提示.为了保护Open/docs-json文件名，我们也需要显式生成JSON.

您不应该将凭据放在代码/存储库中，而应该放在.env中，并通过ConfigService进行访问.

我第一次看到这个解决方案是here.