Users - Gachon-P-project/Back GitHub Wiki

개요

사용자 등록, 외부 API와 연동하여 등록된 사용자인지 확인, 사용자 정보 조회, 시간표 조회를 수행하는 로직

사용자 등록

  • URL

    /users

  • Method

    POST

  • Data Params

이름 설명 타입 필수
user_no 사용자 학번 Int O
user_id 사용자 ID VARCHAR(20) O
user_name 사용자 이름 VARCHAR(20) O
nickname 사용자 닉네임 VARCHAR(10) O
user_major 사용자 학과 VARCHAR(30) O
  • Sample Call
http://localhost:17394/users
  • Data Input Exaple:
{ 
    "user_no" : "201700000",
    "user_id" : "user_test",
    "user_name": "테스트",
    "nickname" : "테스트계정이다",
    "user_major": "컴퓨터공학과"
}
  • Success Response
Code: 200
  • Error Response
Code: 400 BAD REQUEST

사용자 확인 및 조회

  • URL

    /users/check

  • Method

    POST

  • Data Params

이름 설명 타입 필수
id 사용자 ID String O
pwd 사용자 Password String O
  • Sample Call
http://localhost:17394/users/check
  • Data Input Exaple:
{ 
    "id" : "GACHON_ID",
    "pwd" : "GACHON_PWD"
}
  • Success Response
* 등록된 사용자일 경우
{
    "code": 200,
    "data": {
        "user_no": "201739412",
        "user_id": "jy11290",
        "user_name": "김진영",
        "user_major": "컴퓨터공학과",
        "nickname": "jy-kkkim"
    }
}

* 등록되지 않은 사용자일 경우
{
    "code": 204,
    "data": {
        "user_no": "201739412",
        "user_id": "jy11290",
        "user_name": "김진영",
        "user_major": "컴퓨터공학과"
    }
}
  • Error Response
* 로그인 실패
{ "ID/PW를 확인하세요." }

* 서버 연결 실패
{ "DB 연결 오류" }

시간표 조회

  • URL

    /users/timetable/:user_no/:year/:sem

  • Method

    GET

  • URL Params

이름 설명 타입 필수
user_no 사용자 학번 String O
year 조회할 년도 String O
sem 조회할 학기(10: 1학기, 11: 여름학기, 20: 2학기, 21: 겨울학기) String O
  • Sample Call
http://localhost:17394/user/timetable/201739412/2020/20
  • Success Response
[
    {
        "day": "월요일 MONDAY",
        "data": [
            {
                "subject": "창업과 기업가정신 / 비전타워-B201 /  최창명",
                "time": "1100 ~ 1150"
            },
            {
                "subject": "창업과 기업가정신 / 비전타워-B201 /  최창명",
                "time": "1200 ~ 1250"
            },
            {
                "subject": "컴퓨터구조 / IT대학-602 /  이상순",
                "time": "1430 ~ 1545"
            },
            {
                "subject": "종합프로젝트 / IT대학-502 /  임준식",
                "time": "1825 ~ 1915"
            },
            {
                "subject": "종합프로젝트 / IT대학-502 /  임준식",
                "time": "1920 ~ 2010"
            },
            {
                "subject": "종합프로젝트 / IT대학-502 /  임준식",
                "time": "2015 ~ 2105"
            }
        ]
    },
    {
        "day": "화요일 TUESDAY",
        "data": [
            {
                "subject": "컴퓨터구조 / IT대학-602 /  이상순",
                "time": "1600 ~ 1715"
            },
            {
                "subject": "종합프로젝트 / IT대학-502 /  임준식",
                "time": "1825 ~ 1915"
            },
            {
                "subject": "종합프로젝트 / IT대학-502 /  임준식",
                "time": "1920 ~ 2010"
            }
        ]
    },
    {
        "day": "수요일 WEDNESDAY",
        "data": [
            {
                "subject": "대기업·중견기업 취업 준비전략 / 가천관-B101 /  조진수",
                "time": "1300 ~ 1350"
            },
            {
                "subject": "대기업·중견기업 취업 준비전략 / 가천관-B101 /  조진수",
                "time": "1400 ~ 1450"
            }
        ]
    }
]
  • Error Response
Code: 400 BAD REQUEST

닉네임 중복확인

  • URL

    /user/nickname/check/:nickname

  • Method

    GET

  • URL Params

이름 설명 타입 필수
nickname 사용할 닉네임 String O
  • Sample Call
http://localhost:17394/users/nickname/check/테스트계정이다
  • Success Response
* 사용 가능
"사용가능한 닉네임 입니다."

* 사용 불가능
"이미 등록된 닉네임 입니다."
  • Error Response
Code: 400 BAD REQUEST

닉네임 수정

  • URL

    /users/nickname

  • Method

    PUT

  • Data Params

이름 설명 타입 필수
nickname 사용자 닉네임 VARCHAR(10) O
user_no 사용자 학번 Int O
  • Sample Call
http://localhost:17394/users/nickname
  • Data Input Exaple:
{ 
    "nickname": "닉네임수정",
    "user_no": "201700000"
}
  • Success Response
Code: 200
  • Error Response
Code: 400 BAD REQUEST

수업 URL 조회

  • URL

    /users/subject-url

  • Method

    POST

  • Data Params

이름 설명 타입 필수
subject 수업 이름 VARCHAR(70) O
professor 교수 이름 VARCHAR(30) O
  • Sample Call
http://localhost:17394/users/subject-url
  • Data Input Exaple:
[
    {
        "subject" : "모바일웹",
        "professor" : "최진우"
    },
    {
        "subject" : "ERP프로젝트",
        "professor" : "이영호"
    }
]
  • Success Response
[
    {
        "subject": "모바일웹",
        "professor": "최진우",
        "url": "http://gachon.webex.com/meet/jwchoi"
    },
    {
        "subject": "ERP프로젝트",
        "professor": "이영호",
        "url": "http://gachon.webex.com/meet/lyh"
    }
]
  • Error Response
Code: 400 BAD REQUEST
⚠️ **GitHub.com Fallback** ⚠️