API Overview

1. 본 문서는 boribori의 로그인 api 명세 문서입니다.

Request

POST /api/login/{service-name}

Path Variables

/api/login/{service-name}

• {service-name} → 로그인 서비스 이름
  • kakao

Query Parameter

/api/login/{service-name}?code=~

• code → Oauth2 서버로부터 제공받은 Authorization Code

Header

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

Body

❌

Response

Success

로그인 성공

성공적으로 사용자를 생성하여 데이터베이스에 저장된 경우의 응답

HTTP Status Code → 200 OK

Response Body

// JSON
{
  "status": {
		"msg":"성공적으로 로그인이 되었습니다."
  },
  "content": { 
		"id": "<사용자 DB id(Pk)>",
    "tokenId": "<토큰 저장 정보>", // 별도로 사용하지 않아도 됩니다.
    "accessToken": "<발급된 AccessToken>",
    "refreshToken": "<발급된 RefreshToken>",
    "nickname": "<사용자 닉네임>"
 }
}

• status → 요청 처리에 대한 결과 정보
  • msg → 응답 코드에 대한 메시지
• content → 추가적인 정보가 있는 경우 담길 컨텐츠
  • id : 사용자의 DB Pk
  • tokenId : 발급된 토큰의 DB Pk
  • accessToken : 발급된 자체 서버 AccessToken
  • refreshToken : 발급된 자체 서버 RefreshToken
  • nickname : Oauth2 서버로부터 제공받은 닉네임

Failure

잘못된 Code로 전송

잘못된 Code를 서버에 전송 시 발생하는 Response

HTTP Status Code → 400 Bad Request

Response Body

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

• status : 요청 처리에 대한 결과 정보
  • msg : 응답 코드에 대한 메시지
• content : 요청 실패 시, 추가적인 정보 없음