User Auth API

User Auth API

회원 가입

Request

• url

  /v1/sign-in

• method

  POST

• request body

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

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

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

  • 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

로그인

Request

• url

  /login

• method

  POST

• request body

  {
  
  }
  

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

Response

• success response

  {
      "status": 200,
      "success": true,
      "message": {{String}}
  }
  

  Field	Type	Description	Example	Required
  status	integer	HTTP STATUS CODE	200	O
  success	boolean	성공 여부	true	O
  message	String	로그인 성공 메세지		O

• 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

로그 아웃

Request

• url

  /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

회원 탈퇴

Reqeust

• url

  /sign-out

• method

  ``

{

}

Field	Type	Description	Example	Required

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