nestjs swagger支持cookie认证吗？

Question

我想在我的swagger文档中包含cookie授权，但我似乎没有取得任何进展。

根据https://docs.nestjs.com/openapi/security在nestjs-swagger中似乎支持cookie身份验证。

但是，根据Swagger UI和编辑器的https://Swagger . io/docs/specification/authentic ation/cookie-authentic ation/

我不确定是我没有正确实现cookie验证，还是它不被支持。

下面是我正在尝试的实现。

在DocumentBuilder（）中：

.addCookieAuth('authCookie')

在控制器中:

@ApiCookieAuth()

我尝试将我的cookie名“authCookie”添加到@ ApiCookieAuth()标记中。我也尝试过使用< code >。addCookieAuth('authCookie '，{type: 'apiKey '，in: 'cookie'})

无论我尝试哪种方式，我都会收到一个JWT令牌未找到错误。我知道当我使用邮递员时，这确实有效，所以我对为什么我遇到这个问题感到困惑。

Answer 1

.addCookieAuth('authCookie', {
  type: 'http',
  in: 'Header',
  scheme: 'Bearer'
})

以及控制器中的此类装饰器：

@ApiCookieAuth()

.addCookieAuth(cookieName?: string, options?: SecuritySchemeObject, securityName?: string)

指定< code>securityName后，您还需要将它提供给一个contoller decorator:

在DocumentBuilder中：

.addCookieAuth('auth-cookie', {
  type: 'http',
  in: 'Header',
  scheme: 'Bearer'
},
'in-app-cookie-name')

在控制器中:

@ApiCookieAuth('in-app-cookie-name')

在GitHub上链接此问题

Answer 2

基本上，你可以使用

  SwaggerModule.setup('swagger', app, document, {
    swaggerOptions: {
      requestInterceptor: (req) => {
        req.credentials = 'include';
        return req;
      },
    },
  });

请注意，手动设置cookie值不会对获取请求产生任何影响。

它与＜code＞swagger客户端NestJs