bookathon_B icon indicating copy to clipboard operation
bookathon_B copied to clipboard

[docs] 사용자 로그인용 HTTP API

Open gidskql6671 opened this issue 3 years ago • 0 comments

  • GET /user
    • 현재 로그인된 유저의 정보를 json으로 보내준다.
    • json의 형식은 다음과 같다.
    • { email: string|null, nickName: string|null }
      • email : 알림을 받을 이메일
      • nickName : 다른 사람에게 보일 닉네임
      • OAuth 로그인을 처음한 상태라면, email과 nickName에 null이 들어가있다.
  • GET /auth/github
    • Github OAuth 로그인 페이지를 불러온다.
    • 로그인이 성공하면 쿠키와 세션을 통해 로그인을 관리한다.
    • 로그인 성공한 경우, 실패한 경우 모두 / 경로로 리다이렉트된다.
  • POST /auth/logout
    • 로그아웃을 한다.
    • Response로 보내는 값은 없다. HTTP 상태코드가 200이면 성공한 것.
  • POST /user/edit
    • 현재 로그인된 유저의 정보를 변경한다.
    • 로그인이 되어있지 않다면, 상태코드 401로 응답한다.
    • Request Body로 email과 nickName을 받는다.
    • email 혹은 nickName이 형식에 맞지 않는 경우, 상태 코드 400으로 응답한다.
    • email와 nickName이 적절할 경우, User정보를 업데이트하고, / 경로로 리다이렉트한다.

gidskql6671 avatar Sep 23 '21 11:09 gidskql6671