[BE] auth, user 서버 swagger 추가 및 버저닝 적용 #183

[42inshin]

해당 사항 (중복 선택)

• FEAT : 새로운 기능 추가 및 개선
• FIX : 기존 기능 수정 및 정상 동작을 위한 간단한 추가, 수정사항
• BUG : 버그 수정
• REFACTOR : 결과의 변경 없이 코드의 구조를 재조정
• TEST : 테스트 코드 추가
• DOCS : 코드가 아닌 문서를 수정한 경우
• REMOVE : 파일을 삭제하는 작업만 수행
• RENAME : 파일 또는 폴더명을 수정하거나 위치(경로)를 변경
• ETC : 이외에 다른 경우 - 어떠한 사항인지 작성해주세요.

설명

🔗 관련 이슈

해결한 이슈: closed #183

📝 작업 내용

version

• 헤더에 version을 받아서 버저닝을 할 수 있도록 처리했습니다. 버전이 없는 경우에는 default로 들어올 수 있게 해뒀습니다.
• 추후에 v2를 만들 경우를 대비해 확장성을 위해 작업해뒀습니다.

app.enableVersioning({
    type: VersioningType.HEADER,
    header: "version",
  });

Swagger

• 인증: http://localhost:8000/api/auth/doc
• 유저: http://localhost:8000/api/users/doc

추가 내용

• 인증은 Basic, access, refresh 각각 넣도록 처리되어 있습니다.
• 스키마에 dto 열어보시면 상세설명 적혀 있습니다.
• 새로고침 시에도 유지되게 처리했습니다.(persistAuthorization: true)

[추천]
accessToken의 iat 숫자를 많이 늘리면 오래도록 사용할 수 있습니다. https://jwt.io/에서 변경 가능합니다.
signature에 들어갈 secret key는 .env에 있으니 여유있는 토큰을 만들어서 편하게 쓰세요!

📸 스크린샷(optional)

이미지	설명
	Auth Swagger
	Auth authorizations
	User Swagger
	jwt.io에서 토큰 유효기간 늘리는 방법
	스키마 설명

[juwon5272]

swagger까지! 고생하셨습니다!!

[KSK9820]

최고의 가독성!! 감사합니다~!