feat: add ApiBearerAuth decorator for api-gateway support (#81)

TEAM-LEG3ND · Sep 18, 2023 · a1d42bf · a1d42bf
1 parent 5b97b3a
commit a1d42bf
Show file tree

Hide file tree

Showing 13 changed files with 91 additions and 54 deletions.
diff --git a/src/answer/answer.controller.ts b/src/answer/answer.controller.ts
@@ -1,8 +1,11 @@
 import { Controller, Get, Param } from '@nestjs/common';
 import { AnswerService } from './answer.service';
 import { GetAnswerResponseDto } from './dto/get-answer-response.dto';
+import { ApiBearerAuth } from '@nestjs/swagger';
+import { ACCESS_TOKEN } from '../config/swagger-config';
 
 @Controller('answer')
+@ApiBearerAuth(ACCESS_TOKEN)
 export class AnswerController {
   constructor(private readonly answerService: AnswerService) {}
   @Get()

diff --git a/src/app.controller.ts b/src/app.controller.ts
@@ -2,8 +2,11 @@ import { Controller, Get } from '@nestjs/common';
 import { AppService } from './app.service';
 import { UniversalAccountId, UniversalAccountIdHeader } from './common/account/universal-account-id.decorator';
 import { SwaggerUniversalAccountId } from './config/decorator/swagger-universal-account-id.decorator';
+import { ApiBearerAuth } from '@nestjs/swagger';
+import { ACCESS_TOKEN } from './config/swagger-config';
 
 @Controller()
+@ApiBearerAuth(ACCESS_TOKEN)
 export class AppController {
   constructor(private readonly appService: AppService) {}
 

diff --git a/src/apply-form/apply-form.controller.ts b/src/apply-form/apply-form.controller.ts
@@ -5,8 +5,11 @@ import { GetApplyFormResponseDto } from './dto/get-apply-form-response.dto';
 import { CreateApplyFormResponseDto } from './dto/create-apply-form-response.dto';
 import { UpdateApplyFormDto } from './dto/update-apply-form.dto';
 import { UpdateApplyFormResponseDto } from './dto/update-apply-form-response.dto';
+import { ApiBearerAuth } from '@nestjs/swagger';
+import { ACCESS_TOKEN } from '../config/swagger-config';
 
 @Controller()
+@ApiBearerAuth(ACCESS_TOKEN)
 export class ApplyFormController {
   constructor(private readonly applyFormService: ApplyFormService) {}
 

diff --git a/src/config/swagger-config.ts b/src/config/swagger-config.ts
@@ -1,12 +1,14 @@
 import { INestApplication } from '@nestjs/common';
 import { DocumentBuilder, SwaggerModule } from '@nestjs/swagger';
 
+export const ACCESS_TOKEN = 'access-token';
+
 export function initSwaggerConfig(app: INestApplication): void {
   const config = new DocumentBuilder()
     .setTitle('title example')
     .setDescription('description example')
     .setVersion('1.0.0')
-    .addBearerAuth({ type: 'http', scheme: 'bearer', bearerFormat: 'Token' }, 'access-token')
+    .addBearerAuth({ type: 'http', scheme: 'bearer', bearerFormat: 'Token' }, ACCESS_TOKEN)
     .build();
 
   const document = SwaggerModule.createDocument(app, config);

diff --git a/src/internal-user/internal-user.controller.ts b/src/internal-user/internal-user.controller.ts
@@ -1,17 +1,20 @@
 import { Controller, Get, Param } from '@nestjs/common';
 import { InternalUserService } from './internal-user.service';
+import { ApiBearerAuth } from '@nestjs/swagger';
+import { ACCESS_TOKEN } from '../config/swagger-config';
 
 @Controller()
+@ApiBearerAuth(ACCESS_TOKEN)
 export class InternalUserController {
-    constructor(private readonly internalUserService: InternalUserService) {}
+  constructor(private readonly internalUserService: InternalUserService) {}
 
-    @Get()
-    findAll() {
-        return this.internalUserService.findAll();
-    }
+  @Get()
+  findAll() {
+    return this.internalUserService.findAll();
+  }
 
-    @Get(':id')
-    findOne(@Param('id') id: string) {
-        return this.internalUserService.findOne(+id);
-    }
+  @Get(':id')
+  findOne(@Param('id') id: string) {
+    return this.internalUserService.findOne(+id);
+  }
 }
diff --git a/src/journal/journal.controller.ts b/src/journal/journal.controller.ts
@@ -2,33 +2,36 @@ import { Controller, Get, Param, Post, Patch, Delete, Body } from '@nestjs/commo
 import { JournalService } from './journal.service';
 import { UpdateJournalDto } from './dto/update-journal.dto';
 import { CreateJournalDto } from './dto/create-journal.dto';
+import { ApiBearerAuth } from '@nestjs/swagger';
+import { ACCESS_TOKEN } from '../config/swagger-config';
 
 @Controller()
+@ApiBearerAuth(ACCESS_TOKEN)
 export class JournalController {
-    constructor(private readonly journalService: JournalService) {}
+  constructor(private readonly journalService: JournalService) {}
 
-    @Get()
-    findAll() {
-        return this.journalService.findAll();
-    }
+  @Get()
+  findAll() {
+    return this.journalService.findAll();
+  }
 
-    @Get(':id')
-    findOne(@Param('id') id: string) {
-        return this.journalService.findOne(+id);
-    }
+  @Get(':id')
+  findOne(@Param('id') id: string) {
+    return this.journalService.findOne(+id);
+  }
 
-    @Post()
-    create(@Body() createJournalDto: CreateJournalDto) {
-        return this.journalService.create(createJournalDto);
-    }
+  @Post()
+  create(@Body() createJournalDto: CreateJournalDto) {
+    return this.journalService.create(createJournalDto);
+  }
 
-    @Patch(':id')
-    update(@Param('id') id: string, @Body() updateJournalDto: UpdateJournalDto) {
-        return this.journalService.update(+id, updateJournalDto);
-    }
+  @Patch(':id')
+  update(@Param('id') id: string, @Body() updateJournalDto: UpdateJournalDto) {
+    return this.journalService.update(+id, updateJournalDto);
+  }
 
-    @Delete(':id')
-    remove(@Param('id') id: string) {
-        return this.journalService.remove(+id);
-    }
+  @Delete(':id')
+  remove(@Param('id') id: string) {
+    return this.journalService.remove(+id);
+  }
 }
diff --git a/src/member/member.controller.ts b/src/member/member.controller.ts
@@ -3,9 +3,11 @@ import { UpdateMemberResponseDto } from './dto/update-member-response.dto';
 import { UpdateMemberDto } from './dto/update-member.dto';
 import { MemberService } from './member.service';
 import { Controller, Get, Param, Patch, Body, Delete } from '@nestjs/common';
-import { ApiOperation } from '@nestjs/swagger';
+import { ApiBearerAuth, ApiOperation } from '@nestjs/swagger';
+import { ACCESS_TOKEN } from '../config/swagger-config';
 
 @Controller()
+@ApiBearerAuth(ACCESS_TOKEN)
 export class MemberController {
   constructor(private readonly memberService: MemberService) {}
 

diff --git a/src/notice/notice.controller.ts b/src/notice/notice.controller.ts
@@ -2,33 +2,36 @@ import { Controller, Get, Post, Patch, Delete, Param, Body } from '@nestjs/commo
 import { NoticeService } from './notice.service';
 import { CreateNoticeDto } from './dto/create-notice.dto';
 import { UpdateNoticeDto } from './dto/update-notice.dto';
+import { ApiBearerAuth } from '@nestjs/swagger';
+import { ACCESS_TOKEN } from '../config/swagger-config';
 
 @Controller()
+@ApiBearerAuth(ACCESS_TOKEN)
 export class NoticeController {
-    constructor(private readonly noticeService: NoticeService) {}
+  constructor(private readonly noticeService: NoticeService) {}
 
-    @Get()
-    findAll() {
-        return this.noticeService.findAll();
-    }
+  @Get()
+  findAll() {
+    return this.noticeService.findAll();
+  }
 
-    @Get(':id')
-    findOne(@Param('id') id: string) {
-        return this.noticeService.findOne(+id);
-    }
+  @Get(':id')
+  findOne(@Param('id') id: string) {
+    return this.noticeService.findOne(+id);
+  }
 
-    @Post()
-    create(@Body() createNoticeDto: CreateNoticeDto) {
-        return this.noticeService.create(createNoticeDto);
-    }
+  @Post()
+  create(@Body() createNoticeDto: CreateNoticeDto) {
+    return this.noticeService.create(createNoticeDto);
+  }
 
-    @Patch(':id')
-    update(@Param('id') id: string, @Body() updateNoticeDto: UpdateNoticeDto) {
-        return this.noticeService.update(+id, updateNoticeDto);
-    }
+  @Patch(':id')
+  update(@Param('id') id: string, @Body() updateNoticeDto: UpdateNoticeDto) {
+    return this.noticeService.update(+id, updateNoticeDto);
+  }
 
-    @Delete(':id')
-    remove(@Param('id') id: string) {
-        return this.noticeService.remove(+id);
-    }
+  @Delete(':id')
+  remove(@Param('id') id: string) {
+    return this.noticeService.remove(+id);
+  }
 }
diff --git a/src/question/question.controller.ts b/src/question/question.controller.ts
@@ -1,8 +1,11 @@
 import { Controller, Get, Post, Body, Patch, Param, Delete } from '@nestjs/common';
 import { QuestionService } from './question.service';
 import { CreateQuestionDto } from './dto/create-question.dto';
+import { ApiBearerAuth } from '@nestjs/swagger';
+import { ACCESS_TOKEN } from '../config/swagger-config';
 
 @Controller()
+@ApiBearerAuth(ACCESS_TOKEN)
 export class QuestionController {
   constructor(private readonly questionService: QuestionService) {}
 

diff --git a/src/study/study.controller.ts b/src/study/study.controller.ts
@@ -7,8 +7,11 @@ import { GetStudyResponseDto } from './dto/get-study-response.dto';
 import { UpdateStudyResponseDto } from './dto/update-study-response.dto';
 import { GetNoticeResponseDto } from 'src/notice/dto/get-notice-response.dto';
 import { GetJournalResponseDto } from 'src/journal/dto/get-journal-response.dto';
+import { ApiBearerAuth } from '@nestjs/swagger';
+import { ACCESS_TOKEN } from '../config/swagger-config';
 
 @Controller()
+@ApiBearerAuth(ACCESS_TOKEN)
 export class StudyController {
   constructor(private readonly studyService: StudyService) {}
 

diff --git a/src/tag/tag.controller.ts b/src/tag/tag.controller.ts
@@ -2,8 +2,11 @@ import { Controller, Get, Post, Body, Patch, Param, Delete } from '@nestjs/commo
 import { TagService } from './tag.service';
 import { CreateTagDto } from './dto/create-tag.dto';
 import { UpdateTagDto } from './dto/update-tag.dto';
+import { ApiBearerAuth } from '@nestjs/swagger';
+import { ACCESS_TOKEN } from '../config/swagger-config';
 
 @Controller()
+@ApiBearerAuth(ACCESS_TOKEN)
 export class TagController {
   constructor(private readonly tagService: TagService) {}
 

diff --git a/src/timeFrame/timeframe.controller.ts b/src/timeFrame/timeframe.controller.ts
@@ -1,7 +1,10 @@
 import { Controller, Get, Param } from '@nestjs/common';
 import { TimeFrameService } from './timeframe.service';
+import { ApiBearerAuth } from '@nestjs/swagger';
+import { ACCESS_TOKEN } from '../config/swagger-config';
 
 @Controller()
+@ApiBearerAuth(ACCESS_TOKEN)
 export class TimeFrameController {
   constructor(private readonly timeFrameService: TimeFrameService) {}
 

diff --git a/src/user/user.controller.ts b/src/user/user.controller.ts
@@ -2,8 +2,11 @@ import { Body, Controller, Get, Post, Patch, Delete, Param, HttpCode } from '@ne
 import { UserService } from './user.service';
 import { CreateUserDto } from './dto/create-user.dto';
 import { UpdateUserDto } from './dto/update-user.dto';
+import { ApiBearerAuth } from '@nestjs/swagger';
+import { ACCESS_TOKEN } from '../config/swagger-config';
 
 @Controller()
+@ApiBearerAuth(ACCESS_TOKEN)
 export class UserController {
   constructor(private readonly userService: UserService) {}
 
@@ -35,6 +38,6 @@ export class UserController {
   @Delete(':id')
   @HttpCode(204)
   remove(@Param('id') id: string) {
-      return this.userService.remove(+id);
+    return this.userService.remove(+id);
   }
 }