Xavfsizlik

Ma'lum operatsiya uchun qaysi xavfsizlik mexanizmlari ishlatilishini belgilash uchun @ApiSecurity() dekoratoridan foydalaning.

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

Ilovangizni ishga tushirishdan oldin, DocumentBuilder yordamida bazaviy hujjatingizga xavfsizlik ta'rifini qo'shishni unutmang:

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

Eng mashhur autentifikatsiya usullarining ayrimlari (masalan, basic va bearer) ichki ko'makga ega, shuning uchun xavfsizlik mexanizmlarini yuqoridagi kabi qo'lda belgilashingiz shart emas.

Basic autentifikatsiya

Basic autentifikatsiyani yoqish uchun @ApiBasicAuth() dan foydalaning.

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

Ilovangizni ishga tushirishdan oldin, DocumentBuilder yordamida bazaviy hujjatingizga xavfsizlik ta'rifini qo'shishni unutmang:

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

Bearer autentifikatsiya

Bearer autentifikatsiyani yoqish uchun @ApiBearerAuth() dan foydalaning.

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

Ilovangizni ishga tushirishdan oldin, DocumentBuilder yordamida bazaviy hujjatingizga xavfsizlik ta'rifini qo'shishni unutmang:

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

OAuth2 autentifikatsiya

OAuth2 ni yoqish uchun @ApiOAuth2() dan foydalaning.

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

Ilovangizni ishga tushirishdan oldin, DocumentBuilder yordamida bazaviy hujjatingizga xavfsizlik ta'rifini qo'shishni unutmang:

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

Cookie autentifikatsiya

Cookie autentifikatsiyani yoqish uchun @ApiCookieAuth() dan foydalaning.

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

Ilovangizni ishga tushirishdan oldin, DocumentBuilder yordamida bazaviy hujjatingizga xavfsizlik ta'rifini qo'shishni unutmang:

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