인프런 커뮤니티 질문&답변

AccessToken, RefreshToken 강의 내용을 모두 마친 후에 스웨거 문서 작성 방법에 대해 궁금한 점이 있어 질문 드립니다.

@Headers()를 사용하여 rawToken 값을 전달하는 경우 스웨거 문서에서는 다음과 같이 @ApiBasicAuth('basic'), @ApiBearerAuth('bearer') 형식을 작성을 해야하는지 질문 드립니다.

import { Body, Controller, Headers, Post, UseGuards } from '@nestjs/common';
import { AuthFacade } from '@root/resource/auth/auth.facade';
import { BasicTokenGuard } from '@root/common/guard/basic-token.guard';
import { RefreshTokenGuard } from '@root/common/guard/bearer-token.guard';
import { IsPublic } from '@root/common/decorator/is-public.decorator';
import { ApiBasicAuth, ApiBearerAuth, ApiOkResponse, ApiOperation, ApiTags } from '@nestjs/swagger';
import {
    AccessAndRefreshTokenResponse,
    AccessTokenResponse,
    RefreshTokenResponse,
} from '@root/resource/auth/dto/response/token-response.dto';

@ApiTags('Auth API')
@Controller('v1/auth')
export class AuthController {
    constructor(private readonly authFacade: AuthFacade) {}

    @ApiOperation({ summary: '로그인', description: 'Authorization Basic 이메일:비밀번호 방식으로 로그인합니다.' })
    @ApiBasicAuth('basic')
    @ApiOkResponse({ type: AccessAndRefreshTokenResponse })
    @IsPublic()
    @UseGuards(BasicTokenGuard)
    @Post('login')
    async login(@Headers('authorization') rawToken: string) {
        return await this.authFacade.loginWithEmail(rawToken);
    }

    @ApiOperation({ summary: '회원가입', description: '이메일, 비밀번호로 회원가입을 진행합니다.' })
    @ApiOkResponse({ type: AccessAndRefreshTokenResponse })
    @IsPublic()
    @Post('register')
    async register(@Body('email') email: string, @Body('password') password: string) {
        return await this.authFacade.registerWithEmail(email, password);
    }

    @ApiOperation({ summary: 'AccessToken 갱신', description: 'RefreshToken으로 AccessToken을 갱신합니다.' })
    @ApiBearerAuth('bearer')
    @ApiOkResponse({ type: AccessTokenResponse })
    @IsPublic()
    @UseGuards(RefreshTokenGuard)
    @Post('token/access')
    generateAccessToken(@Headers('authorization') rawToken: string) {
        return this.authFacade.generateAccessToken(rawToken);
    }

    @ApiOperation({ summary: 'RefreshToken 갱신', description: 'RefreshToken으로 RefreshToken을 갱신합니다.' })
    @ApiBearerAuth('bearer')
    @ApiOkResponse({ type: RefreshTokenResponse })
    @IsPublic()
    @UseGuards(RefreshTokenGuard)
    @Post('token/refresh')
    generateRefreshToken(@Headers('authorization') rawToken: string) {
        return this.authFacade.generateRefreshToken(rawToken);
    }
}