Pour définir les mécanismes de sécurité à utiliser pour une opération spécifique, utilise @ApiSecurity()
.
@ApiSecurity('basic')
@Controller('todo')
export class TodoController {}
Avant d'exécuter ton application, n'oublie pas d'ajouter la définition de sécurité à ton document de base en utilisant SpecBuilder
:
const options = new Spec().addSecurity('basic', {
type: 'http',
scheme: 'basic',
});
Certaines des techniques d'authentification les plus populaires sont intégrées (par exemple, basic
et bearer
) et donc tu n'as pas besoin de définir manuellement les mécanismes de sécurité comme indiqué ci-dessus.
Authentification basique
Pour activer l'authentification de base, utilise @ApiBasicAuth()
.
@ApiBasicAuth()
@Controller('todo')
export class TodoController {}
Ajoute la définition de sécurité à ton document de base en utilisant SpecBuilder
:
const options = new SpecBuilder().addBasicAuth();
Authentification Bearer
Pour activer l'authentification Bearer, utilise @ApiBearerAuth()
.
@ApiBearerAuth()
@Controller('todo')
export class TodoController {}
Avant d'exécuter ton application, n'oublie pas d'ajouter la définition de sécurité à ton document de base en utilisant SpecBuilder
:
const options = new SpecBuilder().addBearerAuth();
Authentification OAuth2
Pour activer OAuth2, utilise @ApiOAuth2()
.
@ApiOAuth2(['todos:write'])
@Controller('todo')
export class TodoController {}
Avant d'exécuter ton application, n'oublie pas d'ajouter la définition de sécurité à ton document de base en utilisant SpecBuilder
:
const options = new SpecBuilder().addOAuth2();
Authentification par cookie
Pour activer l'authentification par cookie, utilise @ApiCookieAuth()
.
@ApiCookieAuth()
@Controller('todo')
export class TodoController {}
Avant d'exécuter ton application, n'oublie pas d'ajouter la définition de sécurité à ton document de base en utilisant SpecBuilder
:
const options = new SpecBuilder().addCookieAuth('token');