Skip to content

User API

kimhyeji edited this page Nov 10, 2020 · 9 revisions

전체 user 목록 (전체 assignees 목록 )

Method Endpoint
GET /users
  • responses
    • 성공
      res.status(200).json({
        success: true,
        data: [{
            id: <user_id>,
            nickname: <user_nickname>,
            profileUrl: <user_profileUrl>,
        }, {...}]
      })
    • DB 에러
      res.status(600).json({
        success: false,
        message: "데이터베이스 에러",
      })
    • 서버 내부 에러
      res.status(500).json({
        success: false,
        message: "서버 내부 오류",
      })

OAuth Github 로그인

Method Endpoint
GET /users/github
  • responses
    • 성공 (미정)
      • 공용: 쿠키 (userData: id, nickname, profileUrl: avatarUrl, userToken)
        1. redirect
        res.status(200).json({
          success: true
        })
    • DB 에러
      res.status(600).json({
        success: false,
        message: "데이터베이스 에러",
      })
    • 서버 내부 에러
      res.status(500).json({
        success: false,
        message: "서버 내부 오류",
      })

토큰 검증

Method Endpoint
GET /users/verify
  • responses
    • 성공
      res.status(200).json({
        success: true
      })
    • 실패 (미정)
      res.status(401).json({
        success: false
      })
      고민 중 EMPTY_TOKEN: "헤더에 토큰이 없음", EXPIRED_TOKEN: "유효기간이 지난 토큰", INVALID_TOKEN: "잘못된 토큰",
    • 서버 내부 에러
      res.status(500).json({
        success: false,
        message: "서버 내부 오류",
      })

자체 로그인 (could)

자체 회원가입 (could)

Clone this wiki locally