search

qortmdgur5 / pirates

party chat system, Using python And React
0 stars 0 forks source link

API List #1

Open qortmdgur5 opened 1 month ago

qortmdgur5 commented 1 month ago

요청: 클라이언트 화면단에서 서버로 보내는 데이터 응답: 서버에서 클라이언트의 요청값을 받아서 다시 되돌려 주는 서버 응답 데이터

admim (관리자 사용 API)

owner (사장님 사용 API)

owner , manager(사장님 And 매니저 사용 API)

Selenbp1 commented 1 month ago

요청: 클라이언트 화면단에서 서버로 보내는 데이터 응답: 서버에서 클라이언트의 요청값을 받아서 다시 되돌려 주는 서버 응답 데이터

admim (관리자 사용 API)

  • [x] GET /admin/accomodations (관리자용 게스트 하우스 관리 페이지 - 게스트 하우스 리스트 정보 가져오기 API)

    • 요청

    • isMostReviews : boolean (많은 리뷰 순 조회할 때 true 로 요청, default 최신 숙소 등록 순으로 보내줌.)

    • 응답

    • id : int (숙소 테이블 primary key)

    • name : String (숙소 이름)

    • address : String (숙소 주소)

    • phoneNumber : String || Null (숙소 전화번호)

    • date : String (숙소 등록일, yy.mm.dd 형식으로 포맷팅 후 보내주셈)

  • [x] GET /admin/owners (관리자용 게스트 하우스 승인 관리 페이지 - 사장님 리스트 정보 가져오기 API)

    • 요청

    • isOldestOrders: boolean (오래된 순 조회할 때 true 로 요청, default 최신 순으로 )

    • 응답

    • id : int (사장 테이블 primary key)

    • name : String (사장 이름)

    • username : String (사장 아이디)

    • phoneNumber : String (사장 연락처)

    • isAuth : boolean (사장의 role 권한 판별해서 ROLE_AUTH_OWNER 이면 true 주고, 아니면 false)

  • [x] PUT /admin/owner/auth/{id} (관리자용 게스트 하우스 승인 관리 페이지 - 사장님 승인 API , 승인 요청 시 해당 사장님 role 컬럼을 ROLE_AUTH_OWNER 로 변경) #2

    • 요청

    • id : int (사장 테이블 primary key)

    • 응답

    • 없음

  • [x] PUT /admin/owner/deny/{id} (관리자용 게스트 하우스 승인 관리 페이지 - 사장님 취소 API, 요청 시 사장님 role 컬럼을 ROLE_NOTAUTH_OWNER 로 변경)

    • 요청

    • id : int (사장 테이블 primary key)

    • 응답

    • 없음

owner (사장님 사용 API)

  • [ ] GET /owner/accomodation (사장님용 게스트 하우스 등록 관리 페이지 - 게스트 하우스 정보 가져오기 API)

    • 요청

    • 없음

    • 응답

    • id : int || Null (게스트 하우스 테이블 primary key)

    • name : String (게스트 하우스 이름)

    • introduction : String || Null (게스트 하우스 소개말)

    • address : String (게스트 하우스 주소)

    • phoneNumber : String || Null (게스트 하우스 전화번호)

    • score : float || Null (게스트 하우스 평점)

    • loveCount : int || Null (짝 매칭 카운트)

  • [ ] POST /owner/accomodation (사장님용 게스트 하우스 등록 관리 페이지 - 숙소 등록 API)

    • 요청

    • name : String (게스트 하우스 이름)

    • address : String (게스트 하우스 주소)

    • phoneNumber : String (게스트 하우스 전화번호)

    • 응답

    • 없음

  • [ ] PUT /owner/accomodation (사장님용 게스트 하우스 등록 관리 페이지 - 숙소 수정 API)

    • 요청

    • name : String (게스트 하우스 이름)

    • address : String (게스트 하우스 주소)

    • phoneNumber : String (게스트 하우스 전화번호)

    • 응답

    • 없음

  • [ ] GET /owner/managers (사장님용 매니저 등록 관리 페이지 - 매니저 리스트 정보 가져오기 API)

    • 요청

    • isOldestOrders: boolean (오래된 순 조회할 때 true 로 요청, default 가입날짜 최신 순으로)

    • 응답

    • id : int (매니저 테이블 primary key)

    • name : String (매니저 이름)

    • username : String (매니저 아이디)

    • phoneNumber : String (매니저 전화번호)

    • date : String (매니저 가입날짜, yy.mm.dd 형식으로 포맷팅 후 보내주셈)

    • isAuth : boolean (매니저의 role 권한 판별해서 승인된 매니저면 true 주고, 아니면 false)

  • [ ] PUT /owner/manager/auth/{id} (사장님용 매니저 등록 관리 페이지 - 매니저 승인 API , 승인 요청 시 해당 매니저 role 컬럼을 ROLE_AUTH_MANAGER 로 변경)

    • 요청

    • id : int (매니저 테이블 primary key)

    • 응답

    • 없음

  • [ ] PUT /owner/manager/deny/{id} (사장님용 매니저 등록 관리 페이지 - 매니저 삭제 API , 삭제 요청 시 해당 매니저 정보 삭제)

    • 요청

    • id : int (매니저 테이블 primary key)

    • 응답

    • 없음

owner , manager(사장님 And 매니저 사용 API)

  • [ ] GET /manager/parties (매니저용 파티방 관리 페이지 - 파티방 리스트 가져오기 API)

    • 요청

    • isOldestOrders: boolean (오래된 순 조회할 때 true 로 요청, default 파티날짜 최신 순으로)

    • 응답

    • id : int (파티 테이블 primary key)

    • partyDate : String (파티 일자 yy.mm.dd 형식 포맷팅 후 보내주셈)

    • number : int (최대 인원)

    • partyOpen : boolean (파티 여부, 파티가 열리면 true, 안열리면 false)

    • partyTime : String (파티 시작 시간, 8:00PM 형식으로 포맷팅 후 보내주셈)

  • [ ] POST /manager/party (매니저용 파티방 관리 페이지 - 파티방 개설 API)

    • 요청

    • partyDate : String (파티 날짜, yyyy-mm-dd 형식으로 보내겠음, Date 형식으로 보내기 때문에 포맷팅없이 타입변환만 하면됨.)

    • partyOpen : boolean (파티 여부)

    • partyTime : String (파티 시작 시간, hh-mm-00 형식으로 보내겠음. Time 형식으로 보내기 떄문에 포맷팅없이 타입변환만 하면됨.)

    • number : int (파티 최대인원)

    • 응답

    • 없음

  • [ ] PUT /manager/party/{id} (매니저용 파티방 관리 페이지 - 파티방 수정 API)

    • 요청

    • id : int (파티방 테이블 primary key)

    • partyDate : String (파티 날짜, yyyy-mm-dd 형식으로 보내겠음, Date 형식으로 보내기 때문에 포맷팅없이 타입변환만 하면됨.)

    • partyOpen : boolean (파티 여부)

    • partyTime : String (파티 시작 시간, hh-mm-00 형식으로 보내겠음. Time 형식으로 보내기 떄문에 포맷팅없이 타입변환만 하면됨.)

    • number : int (파티 최대인원)

    • 응답

    • 없음

  • [ ] DELETE /manager/party/{id} (매니저용 파티방 관리 페이지 - 파티방 삭제 API, 요청시 해당 파티방 삭제)

    • 요청

    • id : int (파티방 테이블 primary key)

    • 응답

    • 없음

  • [ ] GET /manager/party/{id} (매니저용 파티 상세 페이지 - 파티 상세 정보 가져오기 API)

    • 요청

    • id : int (파티방 테이블 primary key)

    • 응답

    • party : 객체

      • partyDate : String (파티 일자 yy.mm.dd 형식 포맷팅 후 보내주셈)
      • number : int (최대 인원)
      • partyTime : String (파티 시작 시간, 8:00PM 형식으로 포맷팅 후 보내주셈)

    • participant

      • id : int (paricipant 테이블 primary key)
      • name : String || Null (참석자 이름)
      • phone : String || Null (참석자 핸드폰 번호)
      • age : int || Null (참석자 나이)
      • gender : boolean || Null (참석자 성별 true 면 남자, false 면 여자)

  • [ ] POST /manager/participant/{id} (매니저용 파티 상세 페이지 - 참석자 추가 API)

    • 요청

    • id : int (파티방 테이블 primary key)

    • name : String (참석자 이름)

    • phone : String (참석자 연락처 010-xxxx-xxxx 형식으로 보내겠음)

    • age : int (참석자 나이)

    • gender : boolean (참석자 성별 true 면 남자 false 면 여자)

    • 응답

    • 없음

  • [ ] DELETE /manager/participant/{id} (매니저용 파티 상세 페이지 - 참석자 삭제 API, 요청시 해당 참석자 삭제)

    • 요청

    • id : int (participant 테이블 primary key)

    • 응답

    • 없음

  • [ ] PUT /manager/partyOn/{id} (매니저용 파티 상세 페이지 - 파티 ON/OFF API, 요청시 요청값에 따른 파티방 ON/OFF 처리)

    • 요청

    • id : int (파티방 테이블 primary key)

    • partyOn : boolean (파티방 ON/OFF 변수, true 면 해당 파티방 partyOn 컬럼 true, false면 false)

    • 응답

    • 없음