User Auth API - Yapp-17th/Android_2_Backend GitHub Wiki

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

Base URL

http://101.101.219.23/api/login-service/

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	Long 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

  {
      "status":{{Integer}},
      "success": {{Boolean}},
      "responseType": {{String}},
      "message": {{String}}
  }
  

  Field	Type	Description	Example	Required
  status	integer	HTTP STATUS CODE	500	O
  success	boolean	성공 여부	false	O
  responseType	String	오류 실패 메세지	"USER_NOT_FOUND"	O
  message	String	오류 실패 메세지	"사용자를 찾을 수 없습니다"	O

  status	success	ResponseType	message	상황
  403	false	"SUSPENDED_USER_FAIL"	"신고로 정지된 사용자입니다."	정지된 사용자가 회원 가입을 시도했을 경우
  400	false	"SIGN_UP_DUPLICATE"	"동일한 이메일이 있습니다."	이미 같은 이메일을 가지고 있는 사용자가 회원 가입을 시도했을 경우
  400	false	"SIGN_UP_DUPLICATE"	"이미 가입한 유저입니다."	이미 같은 카카오 accessToken를 가지고 있는 사용자가 회원 가입을 시도했을 경우
  400	false	"SIGN_UP_DUPLICATE"	"동일한 닉네임이 있습니다."	이미 같은 닉네임을 가지고 있는 사용자가 회원 가입을 시도했을 경우
  400	false	"SIGN_UP_DUPLICATE"	"이미 가입한 유저입니다."	이미 같은 카카오 oauthId를 사용자가 회원 가입을 시도했을 경우
  400	false	"INVALID_METHOD"	"메소드 유형이 잘못 되었습니다."	POST가 아닌 다른 메소드로 요청한 경우
  500	false	"INTERNAL_SERVER_ERROR"	"서버 내부 오류"	서버 내부 오류

Login API

Request

• url

  /v1/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":{{Integer}},
      "success": {{Boolean}},
      "responseType": {{String}},
      "message": {{String}}
  }
  

  Field	Type	Description	Example	Required
  status	integer	HTTP STATUS CODE	500	O
  success	boolean	성공 여부	false	O
  responseType	String	오류 실패 메세지	"USER_NOT_FOUND"	O
  message	String	오류 실패 메세지	"사용자를 찾을 수 없습니다"	O

  status	success	ResponseType	message	상황
  404	false	"USER_NOT_FOUND"	"사용자를 찾을 수 없습니다"	로그인 시 해당 정보를 가진 사용자가 없을 경우
  401	false	"INACTIVE_USER_FAIL"	"회원 가입이 필요합니다."	탈퇴한 사용자가 로그인을 시도했을 경우
  403	false	"SUSPENDED_USER_FAIL"	"신고로 정지된 사용자입니다."	정지된 사용자가 로그인을 시도했을 경우
  400	false	"INVALID_METHOD"	"메소드 유형이 잘못 되었습니다."	POST가 아닌 다른 메소드로 요청한 경우
  500	false	"INTERNAL_SERVER_ERROR"	"서버 내부 오류"	서버 내부 오류

auto Login API

Request

• url

  /v1/user/auto-in

• method

  GET

• header

  method	parameter	Description	Required
  Authorization	{{token}}	access token	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

  {
      "status":{{Integer}},
      "success": {{Boolean}},
      "responseType": {{String}},
      "message": {{String}}
  }
  

  Field	Type	Description	Example	Required
  status	integer	HTTP STATUS CODE	500	O
  success	boolean	성공 여부	false	O
  responseType	String	오류 실패 메세지	"USER_NOT_FOUND"	O
  message	String	오류 실패 메세지	"사용자를 찾을 수 없습니다"	O

  status	success	ResponseType	message	상황
  404	false	"USER_NOT_FOUND"	"사용자를 찾을 수 없습니다"	로그인 시 해당 정보를 가진 사용자가 없을 경우
  401	false	"INACTIVE_USER_FAIL"	"회원 가입이 필요합니다."	탈퇴한 사용자가 로그인을 시도했을 경우
  403	false	"SUSPENDED_USER_FAIL"	"신고로 정지된 사용자입니다."	정지된 사용자가 로그인을 시도했을 경우
  400	false	"INVALID_METHOD"	"메소드 유형이 잘못 되었습니다."	POST가 아닌 다른 메소드로 요청한 경우
  500	false	"INTERNAL_SERVER_ERROR"	"서버 내부 오류"	서버 내부 오류

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

  {
      "status":{{Integer}},
      "success": {{Boolean}},
      "responseType": {{String}},
      "message": {{String}}
  }
  

  Field	Type	Description	Example	Required
  status	integer	HTTP STATUS CODE	500	O
  success	boolean	성공 여부	false	O
  responseType	String	오류 실패 메세지	"USER_NOT_FOUND"	O
  message	String	오류 실패 메세지	"사용자를 찾을 수 없습니다"	O

  status	success	ResponseType	message	상황
  404	false	"USER_NOT_FOUND"	"사용자를 찾을 수 없습니다"	탈퇴 시 해당 정보를 가진 사용자가 없을 경우
  401	false	"INACTIVE_USER_FAIL"	"회원 가입이 필요합니다."	탈퇴한 사용자가 탈퇴를 시도했을 경우
  403	false	"SUSPENDED_USER_FAIL"	"신고로 정지된 사용자입니다."	정지된 사용자가 탈퇴를 시도했을 경우
  400	false	"INVALID_REQUEST_BODY"	"정확한 값을 Request Body에 담아서 요청하시기 바랍니다"	로그인 시 요청 request body가 올바르지 않은 경우
  400	false	"INVALID_METHOD"	"메소드 유형이 잘못 되었습니다."	POST가 아닌 다른 메소드로 요청한 경우
  400	false	"INVALID_METHOD"	"메소드 유형이 잘못 되었습니다."	POST가 아닌 다른 메소드로 요청한 경우
  500	false	"INTERNAL_SERVER_ERROR"	"서버 내부 오류"	서버 내부 오류