Skip to content

API 설계서

yexxis edited this page Aug 6, 2022 · 1 revision

회원 관리

회원가입

POST /auth/signup

Request Data


{

"userId": 사용자 ID, (string)

"password": 비밀번호, (string)

“name”: 사용자 실명, (string)

“type”: 선생님/학생인지 선택, (string)

“phoneNumber” : “사용자 전화번호” , (string)

}

{

"userId": "snow00", (string)

"password": "qwer1234", (string)

“name”: “김철수”, (string)

“type”: “학생”, (string)

“phoneNumber” : “01012345678” , (int)

}

Response Data


없음

중복 아이디 체크

GET /auth/signup/check?type=UNIQUE_ID&value=:userId

Request Data


{

"userId": 사용자 ID (string)

}

{

"userId": "snow00" (string)

}

Response Data


없음

로그인

POST /auth/login

Request Data


{

"userId": 사용자 ID, (string)

"password": 비밀번호 (string)

}

정보입력

선생님 정보 입력

POST/teachers/info

Request Data


{

"area": 지역, (string)

"age": 나이, (int)

"style": 성향, (string)

"subject": 과목, (string)

“target” : 가르칠 대상 학년

“university”:대학, (string)

“major”: 전공, (string)

"wage": 시급, (long)

"experience": 경력, (string)

}

{

"area": "서울", (string)

"age": 2001-01-01, (int)

"style": "활발한", (string)

"subject": "국어", (string)

“target” : “고등학교 1학년”, (string)

“university”:”홍익대학교”,(string)

“major”:”컴퓨터공학과”,(string)

"wage": "15000", (long)

"experience": "모의고사 대비 과외 3년 경력", (string)

}

Response Data


없음

학생 정보 입력

POST/students/info

Request Data


{

"area": 지역, (string)

"admission” : 입학일, (int)

"subject": 관심 과목, (string)

"money": 학생이 원하는 지불 금액 단위, (int)

}

{

"area": "서울", (string)

"admission” : 2017-01-01, (int)

"subject": "국어", (string)

"money": "1", (int)

}

Response Data


없음

매칭 기능

학생용 매칭 기능

POST /students/connections

Request Data


{

“name” : 이름, (string)

"area": 지역, (string)

"admission” : 입학일, (int)

"subject": 관심 과목, (string)

"money": 학생이 원하는 지불 금액, (int)

}

Response Data


{

“name” : 이름, (string)

"area": 지역, (string)

"age": 나이, (int)

"style": 성향, (string)

"subject": 과목, (string)

“target” : 가르칠 대상 학년

“university”:대학, (string)

“major”: 전공, (string)

"wage": 시급, (long)

"experience": 경력, (string)

}

학생용 매칭 요청한 내역 확인 기능

GET/students/connections/check

Request Data


없음

Response Data


{

“name” : 이름, (string)

"area": 지역, (string)

"age": 나이, (int)

"style": 성향, (string)

"subject": 과목, (string)

“target” : 가르칠 대상 학년

“university”:대학, (string)

“major”: 전공, (string)

"wage": 시급, (long)

"experience": 경력, (string)

“accpet”: 수락여부, (boolean)

}

선생님용 매칭 요청 확인 기능

GET/ teachers/connections/check

Request Data


없음

Response Data


{

“name” : 이름, (string)

"area": 지역, (string)

"grade": 학년, (string)

"subject": 관심 과목, (string)

"money": 학생이 원하는 지불 금액, (int)

}

매칭 수락 기능

Request Data


없음

Response Data


{

“name”: 사용자(학생,선생님) 실명, (string)

“phoneNumber” : “사용자(학생,선생님) 전화번호” , (string)

}