HPKC - 제공 API

27 Jun 2022 in Reference

동아리, 모임으로 이뤄진 사람들이 자료를 올리고 소통할 수 있는 공간

1. 제공 API
   1. 유저
      1. 로그인
         1. 기본 로그인
         2. 카카오톡 로그인
      2. 생성
      3. 삭제
      4. 수정
      5. 조회
   2. 팀
      1. 생성
      2. 삭제
      3. 수정
         1. 멤버 추가
         2. 멤버 삭제
      4. 조회
   3. 발표
      1. 생성
      2. 삭제
      3. 수정
      4. 조회

제공 API

유저

로그인

기본 로그인

Value	설명	type
/oauth/logins	요청에 필요한 URL	URL
userEmail	로그인 할 유저의 이메일	String
password	로그인 할 유저의 비밀번호	String

return

Value	설명	type
req.user	로그인 한 유저의 기본 정보	Object

카카오톡 로그인

로그인에 필요한 데이터

Value	설명	type
/oauth/kakao	요청에 필요한 URL	URL
req.user	카카오톡 서버 인증	Object

return

|Value|설명|type| |—|—|—| |req.user|로그인에 성공한 유저의 정보|Object|

생성

요청 데이터

Value	설명	type
/oauth/register	요청에 필요한 URL	URL
userName	유저 이름	String
userEmail	유저 이메일	String
password	비밀번호	String

return

Value	설명	type
msg	200,400,403, etc	Object

삭제

수정

조회

팀

생성

요청 데이터

Value	설명	type
/team/create	요청에 필요한 URL	URL
teamName	생성 할 팀 이름	String
subject	팀의 주제	String

return

|Value|설명|type| |—|—|—| |teamName|생성 된 팀 이름|String|

삭제

요청 데이터

Value	설명	type
/team/delete	요청에 필요한 URL	URL
teamName	삭제 할 팀 이름	String

• 필수 : 팀을 생성한 유저만 삭제 가능

return

|Value|설명|type| |—|—|—| |teamName |삭제된 팀 이름|String| |ptName|삭제된 발표|Array|

수정

멤버 추가

요청 데이터

Value	설명	type
/team/memberAppend	요청에 필요한 URL	URL
teamName	멤버 추가할 팀 이름	String
memberEmail	회원가입 및 DB에 들어있는 유저의 이메일	String

멤버 삭제

요청 데이터

|Value|설명|type| |—|—|—| |/team/memberRemove| 요청에 필요한 URL|URL| |teamName|멤버가 삭제될 팀 이름|String| |memberEmail|삭제 될 멤버|String|

• 필수 : 팀을 만든 유저의 권한

조회

발표

생성

요청 데이터

Value	설명	type
/pt/:team_name/createPresentation	요청에 필요한 URL	URL
ptName	발표 이름	String
attendents	발표 참석자	Array
ptOrder	발표 순서	Object
resultVote	투표 결과	Object
joined_people	참석 인원 수	Number

삭제

요청데이터

Value	설명	type
/pt/delete	요청에 필요한 URL	URL
teamName	팀 이름	String
ptName	발표 이름	String

응답데이터

|Value|설명|type| |—|—|—| |data|요청에 대한 응답을 담은 데이터|Object| |data.success|요청에 성공,실패|Boolean| |data.msg|삭제된 발표이름|String|

수정

요청데이터

Value	설명	type
/pt/update	요청에 필요한 URL	URL
teamName	팀 이름	String
ptName	발표 이름	String
presentation	발표 수정내용	Object

응답데이터

|Value|설명|type| |—|—|—| |data|요청에 대한 응답을 담은 데이터|Object| |data.success|요청에 성공,실패|Boolean| |data.msg|수정된 발표이름|String|

조회