Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

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

Open
gidskql6671 opened this issue Sep 23, 2021 · 0 comments
Open

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

gidskql6671 opened this issue Sep 23, 2021 · 0 comments
Labels
documentation Improvements or additions to documentation

Comments

@gidskql6671
Copy link
Member

gidskql6671 commented Sep 23, 2021

  • 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 gidskql6671 added the documentation Improvements or additions to documentation label Sep 23, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

No branches or pull requests

1 participant