API Overview

1. 본 API는 RefreshToken을 통한 AccessToken을 갱신하기위한 API 입니다.

Request

POST /api/refresh

Path Variables

❌

Query Parameter

/user?refreshToken=~

• refreshToken → 사용자에게 발급한 RefreshToken (필수)

Header

• Content-Type → application/json
• Accept → application/json

Body

❌

ㅁㄴㅇ

Response

Success

AccessToken 갱신 성공

사용자가 제공한 RefreshToken이 유효하여 새로운 AccessToken 갱신에 성공한 경우

HTTP Status Code → 200 OK

Response Body

// JSON
{
  "status": {
        "msg": "성공적으로 갱신되었습니다."
    },
    "content": {
        "id": "<사용자 DB pk>",
        "tokenId": "<Token DB pk>",
        "accessToken": "<갱신된 AccessToken>",
        "refreshToken": "<RefreshToken>", //해당 프로퍼티는 2가지 경우가 존재합니다.
        "nickname": "차영호"
    }
}

• status → 요청 처리에 대한 결과 정보
  • msg : 서버 응답 메세지
• content → 추가적인 정보가 있는 경우 담길 컨텐츠
  • id : 사용자 DB Pk
  • tokenId : Token DB Pk
  • accessToken : 갱신된 AccessToken
  • refreshToken : RefreshToken
    • RefreshToken의 만료까지 3일 남은 경우 새로운 RefreshToken을 응답
    • RefreshToken의 만료까지 3일이상 남은 경우 기존 RefreshToekn을 응답
  • nickname : 사용자 닉네임

Failure

1. RefreshToken 변조

사용자의 요청인 “RefreshToken”이 변조되었을 때의 응답

HTTP Status Code → 401 UnAuthorized

Response Body

// JSON
{
  "content" : 
    {
      "status": {
        "msg": "Invalid Token"
    },
    "content": null
    }
  
}

• status : 요청 처리에 대한 결과 정보
  • msg : 응답 코드에 대한 메시지
• content : null

2. RefreshToken 만료

사용자의 요청인 “RefreshToken”이 만료되었을 때의 응답

HTTP Status Code → 401 UnAuthorized

Response Body

// JSON
{
  "content" : 
    {
      "status": {
        "msg": "Expired Token"
    },
    "content": null
    }
  
}

• status : 요청 처리에 대한 결과 정보
  • msg : 응답 코드에 대한 메시지
• content : null

3. 기타 예외

사용자의 요청인 “RefreshToken”이 만료되었을 때의 응답

HTTP Status Code → 400 Bad Request

Response Body

// JSON
{
  "content" : 
    {
      "status": {
        "msg": "Bad Request"
    },
    "content": null
    }
  
}

• status : 요청 처리에 대한 결과 정보
  • msg : 응답 코드에 대한 메시지
• content : null