安全

要定义特定操作应使用哪种安全机制，请使用 @ApiSecurity() 装饰器。

@ApiSecurity('basic')
@Controller('cats')
export class CatsController {}

在运行应用程序之前，请记得使用 DocumentBuilder 将安全定义添加到基础文档中：

const options = new DocumentBuilder().addSecurity('basic', {
  type: 'http',
  scheme: 'basic',
});

一些最常用的认证技术已经内置支持（例如 basic 和 bearer），因此你无需像上面那样手动定义安全机制。

Basic authentication

要启用 Basic 认证，请使用 @ApiBasicAuth()。

@ApiBasicAuth()
@Controller('cats')
export class CatsController {}

在运行应用程序之前，请记得使用 DocumentBuilder 将安全定义添加到基础文档中：

const options = new DocumentBuilder().addBasicAuth();

Bearer authentication

要启用 Bearer 认证，请使用 @ApiBearerAuth()。

@ApiBearerAuth()
@Controller('cats')
export class CatsController {}

在运行应用程序之前，请记得使用 DocumentBuilder 将安全定义添加到基础文档中：

const options = new DocumentBuilder().addBearerAuth();

OAuth2 authentication

要启用 OAuth2，请使用 @ApiOAuth2()。

@ApiOAuth2(['pets:write'])
@Controller('cats')
export class CatsController {}

在运行应用程序之前，请记得使用 DocumentBuilder 将安全定义添加到基础文档中：

const options = new DocumentBuilder().addOAuth2();

Cookie authentication

要启用 Cookie 认证，请使用 @ApiCookieAuth()。

@ApiCookieAuth()
@Controller('cats')
export class CatsController {}

在运行应用程序之前，请记得使用 DocumentBuilder 将安全定义添加到基础文档中：

const options = new DocumentBuilder().addCookieAuth('optional-session-id');