Ana içeriğe geç

Guards

Guard listesi​

GuardAçıklama
AuthGuardAuthorization: Bearer <token> header’ını doğrulayarak HTTP route’larını korur ve decode edilmiş payload’u request’e ekler.

AuthGuard, kimlik doğrulama gerektiren HTTP route’larını korumak için nestjs-auth-module tarafından sağlanır.

Nasıl çalışır?​

  • Authorization header’ını şu formatta okur: Bearer <token>
  • Aktif sağlayıcı üzerinden token’ı decode eder (AuthService.decodeAsync)
  • Decode edilen payload’u request.tokenPayload içine ekler
  • Token yoksa/geçersizse/süresi dolmuşsa UnauthorizedException fırlatır

Kullanım​

Controller veya route koruma​

example.controller.ts
import { Controller, Get, UseGuards } from '@nestjs/common';
import { AuthGuard } from 'nestjs-auth-module';

@Controller('example')
@UseGuards(AuthGuard)
export class ExampleController {
@Get('private')
privateRoute() {
return { ok: true };
}
}

Sadece tek endpoint’i koruma​

example.controller.ts
import { Controller, Get, UseGuards } from '@nestjs/common';
import { AuthGuard } from 'nestjs-auth-module';

@Controller('example')
export class ExampleController {
@Get('private')
@UseGuards(AuthGuard)
privateRoute() {
return { ok: true };
}

@Get('public')
publicRoute() {
return { ok: true };
}
}
not

AuthGuard decode edilmiş payload’u request.tokenPayload içine koyar. Buna temiz şekilde erişmek için Dekoratörler sayfasındaki decorator’ları kullanın.