Merge: 리프레시 토큰 적용 및 API 문서 포맷 변경

[Zamoca42]

PR 체크리스트

아래 항목을 확인해 주세요:

• 커밋 메시지가 우리의 가이드라인을 따르고 있는지 확인하세요
• 변경 사항에 대한 테스트가 추가되었는지 확인하세요 (버그 수정 / 기능 추가)
• 문서가 추가되거나 업데이트되었는지 확인하세요 (버그 수정 / 기능 추가)

PR 유형

이 PR은 어떤 종류의 변경을 가져오나요?

• 버그 수정
• 새로운 기능 추가
• 코드 스타일 업데이트 (서식, 로컬 변수)
• 리팩터링 (기능 변경 없음, API 변경 없음)
• 빌드 관련 변경
• CI 관련 변경
• 문서 내용 변경
• 애플리케이션 / 인프라 변경
• 기타... 설명:

관련 이슈

이슈 번호: #20 #21

현재 동작은 무엇인가요?

• 액세스 토큰만을 사용한 로그인 인증 및 인가
• API 문서로 Swagger 문서 사용

새로운 동작은 무엇인가요?

• 리프레시 토큰 적용
• 리프레시 토큰을 쿠키에 적용
• 만료된 액세스토큰과 리프레시 토큰으로 새로운 토큰 발급
• API 문서 형식을 Scalar 문서로 변경

이 PR은 호환성 변경을 도입하나요?

• 예
• 아니요

기타 정보

API 문서 스크린샷

인증 관련 참고링크들

• https://docs.nestjs.com/custom-decorators
• https://velog.io/@ohzzi/Access-Token%EA%B3%BC-Refresh-Token%EC%9D%84-%EC%96%B4%EB%94%94%EC%97%90-%EC%A0%80%EC%9E%A5%ED%95%B4%EC%95%BC-%ED%95%A0%EA%B9%8C
• https://inpa.tistory.com/entry/WEB-%F0%9F%93%9A-Access-Token-Refresh-Token-%EC%9B%90%EB%A6%AC-feat-JWT
• https://inpa.tistory.com/178

[sheepdog13]

수고하셨습니다
refreshToken의 필요성이랑 JWT 방식의 인증의 flow를 배울 수 있어서 좋았습니다

[sheepdog13]

refreshToken은 보이는데 accessToken은 같이 발급이 안되나요?
accessToken은 유효기간이 어느정도 되나요?

[Zamoca42]

로그인을 하면 리프레시 토큰과 액세스 토큰이 한번에 발급됩니다.
리프레시 토큰은 쿠키에 저장하고 액세스 토큰은 AuthResponse 클래스로 직렬화해서 Response Body로 보내집니다.

accessToken은 유효기간이 1시간으로 설정했고 리프레시 토큰의경우 쿠키 만료시간인 14일로 지정했습니다.

AuthResponse

backend/src/auth/res-auth.dto.ts

import { ApiProperty } from '@nestjs/swagger';
import { Session } from '@supabase/supabase-js';
import { Exclude, Expose } from 'class-transformer';

export class AuthResponse {
  @Exclude() private readonly _accessToken: string;
  @Exclude() private readonly _refreshToken: string;
  @Exclude() private readonly _expiresIn: number;
  @Exclude() private readonly _tokenType: string;

  constructor(data: Session) {
    this._accessToken = data.access_token;
    this._refreshToken = data.refresh_token;
    this._expiresIn = data.expires_in;
    this._tokenType = data.token_type;
  }

  @Expose()
  @ApiProperty({
    description: '로그인이 성공한 후 반환된 Access Token 입니다.',
  })
  get accessToken(): string {
    return this._accessToken;
  }

  @Exclude()
  @ApiProperty({
    description: '로그인이 성공한 후 반환된 Refresh Token 입니다.',
  })
  get refreshToken(): string {
    return this._refreshToken;
  }

  @Expose()
  @ApiProperty({
    description: 'Access Token의 만료 시간입니다.',
  })
  get expiresIn(): number {
    return this._expiresIn;
  }

  @Expose()
  @ApiProperty({
    description: 'Access Token의 타입입니다.',
  })
  get tokenType(): string {
    return this._tokenType;
  }
}

로그인 결과 Json

response 에서 accessToken이 보여집니다.

[sheepdog13]

오 확인했습니다
유효기간은 1시간이군요 감사합니다