User Auth API

• Sign up API
  • Request
  • Response
• Login API
  • Request
  • Response
• Logout API
  • Request
  • Response
• Sign out API
  • Reqeust
  • Response

Sign up API

Request

• url

  /v1/user/sign-up

• method

  POST

• header

  method	parameter	Description	Required
  Content-Type	application/json

• request body

  {
      "userId": {{String}},
      "userName": {{String}},
      "email": {{String}},
      "accessToken": {{String}},
      "nickName": {{String}},
      "address": {{Long}},
      "category": [],
      "intro": {{Long}}
  }
  

  Field	Type	Description	Example	Required
  userId	String	카카오톡에서 받아오는 유저 oauthId		O
  userName	String	카카오톡에서 받아오는 유저 이름		O
  email	String	카카오톡에서 받아오는 유저 이메일		O
  accessToken	String	로그인 토큰		O
  nickName	String	유저 닉네임(중복X)		O
  address	Long	위치		O
  category	List	관심 종목		O
  intro	String	자기소개		O

Response

• success response

  • header

    method	parameter	Description	Required
    Authorization	{{token}}	access token	O

  • body

    {
        "status": 200,
        "success": true,
        "message": "회원가입을 축하드립니다!\n운동플래닛과 건강한 운동생활을\n시작해보세요!"
    }
    

    Field	Type	Description	Example	Required
    status	integer	HTTP STATUS CODE	200	O
    success	boolean	성공 여부	true	O
    message	String	회원가입 성공 메세지		O

• fail response

  • request body 값이 비어있는 경우

  {
      "status": 400,
      "success": false,
      "message": "필요한 값이 없습니다"
  }
  

  • 이미 가입 된 사용자일 경우

  {
      "status": 400,
      "success": false,
      "message": "이미 가입한 사용자입니다"
  }
  

  • 닉네임 중복일 경우

  {
      "status": 500,
      "success": false,
      "message": "중복된 닉네임입니다"
  }
  

  • 서버 내부 오류

  {
      "status": 500,
      "success": false,
      "message": "서버 내부 오류"
  }
  

  Field	Type	Description	Example	Required
  status	integer	HTTP STATUS CODE	500	O
  success	boolean	성공 여부	false	O
  message	String	서버 내부 오류 실패 메세지		O

Login API

Request

• url

  /user/sign-in

• method

  POST

• header

  method	parameter	Description	Required
  Content-Type	application/json

• request body

  {
      "userId": {{String}},
      "email": {{String}},
      "accessToken": {{String}},
      "nickName": {{String}}
  }
  

  Field	Type	Description	Example	Required
  userId	String	카카오톡에서 받아오는 유저 oauthId		O
  email	String	카카오톡에서 받아오는 유저 이메일
  accessToken	String	로그인 토큰		O
  nickName	String	유저 닉네임(중복X)

Response

• success response

  {
      "status": 200,
      "success": true,
      "message": "로그인 성공"
  }
  

  Field	Type	Description	Example	Required
  status	integer	HTTP STATUS CODE	200	O
  success	boolean	성공 여부	true	O
  message	String	회원가입 성공 메세지		O

• fail response

  • 회원 가입이 필요한 경우

  {
      "status": 400,
      "success": false,
      "message": "회원 가입이 필요합니다"
  }
  

  • 서버 내부 오류

  {
      "status": 500,
      "success": false,
      "message": "서버 내부 오류"
  }
  

  Field	Type	Description	Example	Required
  status	integer	HTTP STATUS CODE	500	O
  success	boolean	성공 여부	false	O
  message	String	서버 내부 오류 실패 메세지		O

Logout API

Request

• url

  /v1/user/logout

• method

{

}

Field	Type	Description	Example	Required
userName	String	카카오톡에서 받아오는 유저 이름		O
email	String	카카오톡에서 받아오는 유저 이메일		O
accessToken	String	로그인 토큰		O

Response

• success response

• fail response

  • 서버 내부 오류

  {
      "status": 500,
      "success": false,
      "message": "서버 내부 오류"
  }
  

  Field	Type	Description	Example	Required
  status	integer	HTTP STATUS CODE	500	O
  success	boolean	성공 여부	false	O
  message	String	서버 내부 오류 실패 메세지		O

Sign out API

Reqeust

• url

  /v1/user/withdraw

• method

  DELETE

• header

  method	parameter	Description	Required
  Authorization	{{token}}	access token	O

Response

• success response

  • body

    {
        "status": 200,
        "success": true,
        "message": "사용자 삭제 성공"
    }
    

  Field	Type	Description	Example	Required
  status	integer	HTTP STATUS CODE	200	O
  success	boolean	성공 여부	true	O
  message	String	유저 삭제 성공 메세지		O

• fail response

  • 글 번호 param이 없는 경우

  {
      "status": 400,
      "success": false,
      "message": "삭제할 사용자 번호가 필요합니다."
  }
  

  • 삭제 하고자 하는 사용자 아이디와 토큰의 아이디가 다른 경우

  {
      "status": 400,
      "success": false,
      "message": "본인의 아이디가 아닙니다."
  }
  

  • access token이 없는 경우

  {
      "status": 400,
      "success": false,
      "message": "토큰이 없습니다."
  }
  

  • 삭제된 사용자일 경우

  {
      "status": 400,
      "success": false,
      "message": "삭제된 사용자입니다."
  }
  

  • access token이 만료 되었을 경우/유효하지 않은 토큰인 경우

  {
      "status": 401,
      "success": false,
      "message": "access token refresh가 필요합니다."
  }
  

  • 서버 내부 오류

  {
      "status": 500,
      "success": false,
      "message": "서버 내부 오류"
  }
  

  Field	Type	Description	Example	Required
  status	integer	HTTP STATUS CODE	500	O
  success	boolean	성공 여부	false	O
  message	String	서버 내부 오류 실패 메세지		O