NestJS’de Swagger’\u0131 JWT Kimlik Do\u011frulamas\u0131yla Kusursuz Bir \u015eekilde Entegre Etme<\/p>\n
NestJS, TypeScript ile yaz\u0131lm\u0131\u015f, g\u00fc\u00e7l\u00fc, \u00f6l\u00e7eklenebilir ve sa\u011flam mimariye sahip bir Node.js \u00e7er\u00e7evesidir. Swagger, API’leriniz i\u00e7in etkile\u015fimli bir dok\u00fcmantasyon ve test ortam\u0131 sa\u011flayan a\u00e7\u0131k kaynakl\u0131 bir ara\u00e7t\u0131r. JWT (JSON Web Token), API’lerinize g\u00fcvenli eri\u015fimi do\u011frulamak i\u00e7in yayg\u0131n olarak kullan\u0131lan standart bir y\u00f6ntemdir.<\/p>\n
Bu makalede, NestJS uygulamalar\u0131n\u0131zda Swagger’\u0131 JWT kimlik do\u011frulamas\u0131yla nas\u0131l sorunsuz bir \u015fekilde entegre edece\u011finizi ad\u0131m ad\u0131m a\u00e7\u0131klayaca\u011f\u0131z. B\u00f6ylece, API’leriniz i\u00e7in g\u00fcvenli ve dok\u00fcmante edilmi\u015f bir aray\u00fcz olu\u015fturabilirsiniz.<\/p>\n
* Node.js ve npm (veya yarn)
\n* Bir NestJS projesi<\/p>\n
\u00d6ncelikle, yeni bir NestJS projesi olu\u015fturun veya mevcut bir projenizi kullan\u0131n. Daha sonra, a\u015fa\u011f\u0131daki paketleri kurman\u0131z gerekecektir:<\/p>\n
“`bash
\nnpm install @nestjs\/platform-express @nestjs\/swagger @nestjs\/passport passport-jwt
\n“`<\/p>\n
\u0130lk olarak, `main.ts` dosyas\u0131nda Swagger’\u0131 yap\u0131land\u0131ral\u0131m:<\/p>\n
“`typescript
\nimport { NestFactory } from ‘@nestjs\/core’;
\nimport { AppModule } from ‘.\/app.module’;
\nimport { DocumentBuilder, SwaggerModule } from ‘@nestjs\/swagger’;<\/p>\n
async function bootstrap() {
\n const app = await NestFactory.create(AppModule);<\/p>\n
const config = new DocumentBuilder()
\n .setTitle(‘My API’)
\n .setDescription(‘API description’)
\n .setVersion(‘1.0’)
\n .addTag(‘users’)
\n .build();
\n const document = SwaggerModule.createDocument(app, config);
\n SwaggerModule.setup(‘api’, app, document);<\/p>\n
await app.listen(3000);
\n}
\nbootstrap();
\n“`<\/p>\n
Bu kod blo\u011fu, Swagger’\u0131 yap\u0131land\u0131rarak API’niz i\u00e7in bir dok\u00fcmantasyon olu\u015fturur. Bu dok\u00fcmantasyon, API’nizin u\u00e7 noktalar\u0131n\u0131n listelerini, parametrelerini ve yan\u0131tlar\u0131n\u0131 i\u00e7erecektir.<\/p>\n
JWT kimlik do\u011frulamas\u0131 i\u00e7in `@nestjs\/passport` ve `passport-jwt` paketlerini kullanaca\u011f\u0131z. \u00d6ncelikle, `AuthModule` adl\u0131 yeni bir mod\u00fcl olu\u015fturun:<\/p>\n
“`typescript
\nimport { Module } from ‘@nestjs\/common’;
\nimport { JwtModule } from ‘@nestjs\/jwt’;
\nimport { PassportModule } from ‘@nestjs\/passport’;
\nimport { JwtStrategy } from ‘.\/jwt.strategy’;
\nimport { AuthService } from ‘.\/auth.service’;
\nimport { UsersModule } from ‘..\/users\/users.module’;<\/p>\n
@Module({
\n imports: [
\n UsersModule,
\n PassportModule.register({ defaultStrategy: ‘jwt’ }),
\n JwtModule.register({
\n secret: ‘your-secret-key’,
\n signOptions: { expiresIn: ‘1h’ },
\n }),
\n ],
\n providers: [AuthService, JwtStrategy],
\n exports: [AuthService, JwtModule],
\n})
\nexport class AuthModule {}
\n“`<\/p>\n
Bu mod\u00fcl, JWT stratejisi ve JWT kimlik do\u011frulamas\u0131 i\u00e7in gerekli olan servisleri i\u00e7erir. `secret` de\u011fi\u015fkeni, JWT’leri imzalamak ve do\u011frulamak i\u00e7in kullan\u0131lan gizli bir anahtard\u0131r.<\/p>\n
`jwt.strategy.ts` dosyas\u0131nda JWT stratejisini tan\u0131mlayal\u0131m:<\/p>\n
“`typescript
\nimport { Injectable } from ‘@nestjs\/common’;
\nimport { PassportStrategy } from ‘@nestjs\/passport’;
\nimport { ExtractJwt, Strategy } from ‘passport-jwt’;
\nimport { ConfigService } from ‘@nestjs\/config’;<\/p>\n
@Injectable()
\nexport class JwtStrategy extends PassportStrategy(Strategy) {
\n constructor(private configService: ConfigService) {
\n super({
\n jwtFromRequest: ExtractJwt.fromAuthHeaderAsBearerToken(),
\n ignoreExpiration: false,
\n secretOrKey: configService.get(‘JWT_SECRET’),
\n });
\n }<\/p>\n
async validate(payload: any) {
\n return { userId: payload.sub, username: payload.username };
\n }
\n}
\n“`<\/p>\n
Bu strateji, istekte bulunan JWT’nin ge\u00e7erlili\u011fini do\u011frulayacakt\u0131r.<\/p>\n
Swagger’\u0131 JWT ile korumak i\u00e7in `@nestjs\/swagger` paketindeki `@ApiBearerAuth` dekorat\u00f6r\u00fcn\u00fc kullanaca\u011f\u0131z.<\/p>\n
“`typescript
\nimport { Controller, Get, UseGuards } from ‘@nestjs\/common’;
\nimport { AuthGuard } from ‘@nestjs\/passport’;
\nimport { ApiBearerAuth, ApiTags } from ‘@nestjs\/swagger’;<\/p>\n
@ApiTags(‘secured’)
\n@Controller(‘secured’)
\n@UseGuards(AuthGuard(‘jwt’))
\n@ApiBearerAuth()
\nexport class SecuredController {
\n @Get()
\n getSecuredData() {
\n return ‘Protected data’;
\n }
\n}
\n“`<\/p>\n
Bu kod blo\u011fu, `SecuredController`’\u0131 JWT kimlik do\u011frulamas\u0131 gerektiren bir denetleyici olarak i\u015faretler. `@ApiBearerAuth` dekorat\u00f6r\u00fc, Swagger dok\u00fcmantasyonuna JWT kimlik do\u011frulamas\u0131 gerekti\u011fi bilgisini ekler.<\/p>\n
Bu makalede, NestJS uygulamalar\u0131n\u0131zda Swagger’\u0131 JWT kimlik do\u011frulamas\u0131yla nas\u0131l sorunsuz bir \u015fekilde entegre edece\u011finizi \u00f6\u011frendiniz. Bu ad\u0131mlar\u0131 izleyerek API’leriniz i\u00e7in g\u00fcvenli ve dok\u00fcmante edilmi\u015f bir aray\u00fcz sa\u011flayabilirsiniz.<\/p>\n
* NestJS Dok\u00fcmantasyonu: Kimlik Do\u011frulama<\/a> #Etiketler
\n* Swagger Dok\u00fcmantasyonu: Kimlik Do\u011frulama<\/a>
\n* Fatih Soysal Blog<\/a> <\/p>\n
\nNestJS, Swagger, JWT, Kimlik Do\u011frulama, API Dok\u00fcmantasyonu, API G\u00fcvenli\u011fi, PassportJS<\/p>\n","protected":false},"excerpt":{"rendered":"NestJS’de Swagger’\u0131 JWT Kimlik Do\u011frulamas\u0131yla Kusursuz Bir \u015eekilde Entegre Etme NestJS, TypeScript ile yaz\u0131lm\u0131\u015f, g\u00fc\u00e7l\u00fc, \u00f6l\u00e7eklenebilir ve sa\u011flam…","protected":false},"author":1,"featured_media":0,"comment_status":"open","ping_status":"open","sticky":false,"template":"","format":"standard","meta":{"csco_page_header_type":"","csco_page_load_nextpost":"","csco_page_subscribe_form":"","csco_page_contact_form":"","footnotes":""},"categories":[1],"tags":[],"class_list":{"0":"post-2857","1":"post","2":"type-post","3":"status-publish","4":"format-standard","6":"category-genel","7":"cs-entry","8":"cs-video-wrap"},"yoast_head":"\n