Sécurité

Pour définir les mécanismes de sécurité à utiliser pour une opération spécifique, utilisez le @ApiSecurity() décorateur.

Définir la sécurité de l'API

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

Avant de lancer votre application, n’oubliez pas d’ajouter la définition de sécurité à votre document de base en utilisant DocumentBuilder :

Ajout de la définition de sécurité

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

Certaines des techniques d’authentification les plus populaires sont intégrées (par exemple, basic et bearer) et vous n’avez donc pas à définir manuellement les mécanismes de sécurité comme indiqué ci-dessus.

Authentification de base

Pour activer l’authentification de base, utilisez @ApiBasicAuth().

Activer l'authentification de base

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

Avant de lancer votre application, n’oubliez pas d’ajouter la définition de sécurité à votre document de base en utilisant DocumentBuilder :

Ajout de la définition d'authentification de base

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

Authentification par jeton

Pour activer l’authentification par jeton, utilisez @ApiBearerAuth().

Activer l'authentification par jeton

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

Avant de lancer votre application, n’oubliez pas d’ajouter la définition de sécurité à votre document de base en utilisant DocumentBuilder :

Ajout de la définition d'authentification par jeton

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

Authentification OAuth2

Pour activer l’OAuth2, utilisez @ApiOAuth2().

Activer l'authentification OAuth2

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

Avant de lancer votre application, n’oubliez pas d’ajouter la définition de sécurité à votre document de base en utilisant DocumentBuilder :

Ajout de la définition d'authentification OAuth2

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

Authentification par cookie

Pour activer l’authentification par cookie, utilisez @ApiCookieAuth().

Activer l'authentification par cookie

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

Avant de lancer votre application, n’oubliez pas d’ajouter la définition de sécurité à votre document de base en utilisant DocumentBuilder :

Ajout de la définition d'authentification par cookie

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