🧸KIDS~CAFE

다양한 검색 조건으로 전국의 키즈 카페를 검색할 수 있는 서비스

📜요구 사항 명세서

• 다양한 검색 조건으로 전국의 키즈 카페를 검색
• 초반엔 크롤링으로 전국의 카페를 일괄 등록
• 관리자, 사장님, 유저 권한을 부여하여 각 권한에 따라 이용가능한 기능을 제한
• 소셜로그인 연동으로 간편한 회원가입
• 예약 및 결제 시스템 연동

👩‍👧‍👦팀 소개

📌노션 링크

👑김혜진 (리더)	👑박견우 (부리더)	박도현 (팀원)	류지수 (팀원)	김현정 (팀원)
Github Blog	Github	Github Blog	Github Blog	Github Blog

🖥️시스템 구성도

🎨와이어 프레임

📋ERD

🖥️개발환경

🧷사용 언어/라이브러리

🧷운용 환경

🧷개발 환경 & 데이터베이스

🧷외부 API

📑API 명세서

🧷유저 API 명세

담당자	Method	Role	기능	API path	진행 상태
박도현	POST	Public	🔗회원 가입	/api/auth/signup	완료
박도현	POST	Public	🔗로그인	/api/auth/signin	완료
박도현	GET	Public	🔗소셜 로그인	/api/oauth2/{provider}/signin	완료
김혜진	GET	Admin	🔗회원 조회(관리자)	/api/admin/users	완료
김혜진	GET	Owner	🔗회원 조회(가게를 즐겨찾기 한)	/api/owners/users	완료
김혜진	GET	User	🔗프로필 조회	/api/owners/users	완료
김혜진	PUT	User	🔗프로필 수정	/api/owners/users	완료
김혜진	DELETE	User	🔗회원 탈퇴	/api/owners/users	완료

🧷키즈 카페 API 명세

담당자	Method	Role	기능	API path	진행 상태
김현정	POST	Admin	🔗카페 등록(관리자)	/api/admin/cafes	완료
김현정	POST	Owner	🔗카페 등록(사장님)	/api/owners/cafes	완료
김현정	GET	Public	🔗카페 리스트 조회(유저가 검색)	/api/cafes	완료
김현정	GET	Admin	🔗카페 리스트 조회(관리자 검색)	/api/admin/cafes	완료
김현정	GET	Owner	🔗카페 리스트 조회(사장님이 등록한)	/api/owners/cafes	완료
김현정	GET	Public	🔗카페 상세 조회	/api/cafes/{cafeId}	완료
김현정	PUT	Owner	🔗카페 수정	/api/cafes/{cafeId}	완료
김현정	DELETE	Admin	🔗카페 삭제(관리자)	/api/admin/cafes	완료
김현정	DELETE	Owner	🔗카페 삭제(사장님)	/api/owners/cafes	완료
김현정	POST	Owner	🔗카페 이미지 업로드	/api/owners/cafes	완료
김현정	DELETE	Owner	🔗카페 이미지 삭제	/api/owners/cafes	완료
김혜진	POST	Admin	🔗카페 크롤링	/api/owners/cafes	완료

🧷인기 키워드 API 명세

담당자	Method	Role	기능	API path	진행 상태
류지수	GET	Public	🔗인기 카페(키워드 기반) 검색 v1	/api/cafes/v1/search?keyword={keyword}	완료
류지수	GET	Public	🔗인기 키워드 Top 10 v1	/api/cafes/v1/search/keywords/top10	완료
류지수	GET	Public	🔗인기 카페(키워드 기반) 검색 v2	/api/cafes/v2/search?keyword={keyword}	진행중
류지수	GET	Public	🔗인기 키워드 Top 10 v2	/api/cafes/v2/search/keywords/top10	진행중
류지수	GET	Public	🔗인기 카페(키워드 기반) 검색 v3	/api/cafes/v3/search?keyword={keyword}	진행중
류지수	GET	Public	🔗인기 키워드 Top 10 v3	/api/cafes/v3/search/keywords/top10	진행중

🧷방 API 명세

담당자	Method	Role	기능	API path	진행 상태
박견우	POST	Owner	🔗룸 생성	/api/cafes/{cafeId}/rooms	완료
박견우	GET	Public	🔗룸 조회	/api/cafes/rooms/{roomId}	완료
박견우	PUT	Owner	🔗룸 수정	/api/cafes/rooms/{roomId}	완료
박견우	DELETE	Owner	🔗룸 삭제	/api/cafes/rooms/{roomId}	완료

🧷즐겨찾기 API 명세

담당자	Method	Role	기능	API path	진행 상태
류지수	POST	User	🔗즐겨찾기 추가 및 삭제	/api/cafes/{cafeId}/bookmarks	완료
류지수	GET	User	🔗즐겨찾기 조회(사용자)	/api/users/bookmarks	완료
류지수	GET	Owner	🔗즐겨찾기 조회(카페)	/api/owners/bookmarks	완료

🧷리뷰 API 명세

담당자	Method	Role	기능	API path	진행 상태
박견우	POST	User	🔗리뷰 작성	/api/cafes/{cafeId}/reviews	완료
박견우	GET	Public	🔗특정 키즈 카페의 리뷰 목록 조회	/api/cafes/{cafeId}/reviews	완료
박견우	GET	User	🔗내가 작성한 리뷰 목록 조회	/api/reviews	완료
박견우	PUT	User	🔗리뷰 수정	/api/reviews/{reviewId}	완료
박견우	DELETE	User	🔗리뷰 삭제	/api/reviews/{reviewId}	완료
박견우	POST	Owner	🔗리뷰 이미지 업로드	/api/reviews/images	완료
박견우	DELETE	Owner	🔗리뷰 이미지 삭제	/api/reviews/images	완료
박견우	POST	User	🔗리뷰 추천 & 추천 취소	/api/review/recommend/{review_id}	완료
김혜진	POST	User	🔗영수증 리뷰	/api/cafes/{cafeId}/receipts/reviews	완료

🧷리뷰 신고 API 명세

담당자	Method	Role	기능	API path	진행 상태
박견우	POST	Owner	🔗신고 생성(사장님)	/api/reviews/{reviewId}/reports	완료
박견우	GET	Owner	🔗사장님 본인이 신고한 신고 목록 조회(사장님)	/api/owners/reports	완료
박견우	GET	Admin	🔗사장님들이 신고한 신고 목록 조회(관리자)	/api/admin/reports	완료
박견우	PATCH	Admin	🔗신고 상태 변경	/api/reports/{reportId}	완료

🧷예약 API 명세

담당자	Method	Role	기능	API path	진행 상태
류지수	POST	User	🔗예약 생성	/api/reservations/cafes/{cafeId}	완료
류지수	GET	User	🔗예약 내역 조회(사용자)	/api/users/reservations	완료
류지수	GET	Owner	🔗예약 내역 조회(카페)	/api/owners/reservations/cafes/{cafeId}	완료
류지수	GET	Owner User	🔗예약 상세 조회	/api/users/reservations/{reservationId} /api/owners/reservations/{reservationId}	완료
류지수	PUT	User	🔗예약 정보 수정	/api/users/reservations/{reservationId}/update	완료
류지수	PUT	Owner	🔗예약 수락	/api/owners/reservations/{reservationId}/approve	완료
류지수	PUT	Owner	🔗예약 상태 변경	/api/owners/reservations/{reservationId}/complete	완료
류지수	PUT	Owner User	🔗예약 취소	/api/users/reservations/{reservationId}/cancel /api/owners/reservations/{reservationId}/{cafeId}/cancel	완료

🧷가격 정책 API 명세

담당자	Method	Role	기능	API path	진행 상태
김혜진	POST	Owner	🔗가격 정책 추가	/api/cafes/{cafeId}/prices	완료
김혜진	GET	Owner	🔗가격 정책 조회	/api/cafes/{cafeId}/prices	완료
김혜진	PATCH	Owner	🔗가격 정책 수정	/api/cafes/{cafeId}/prices/{pricesId}	완료
김혜진	DELETE	Owner	🔗가격 정책 삭제	/api/cafes/{cafeId}/prices/{pricesId}	완료

🧷입장료 API 명세

담당자	Method	Role	기능	API path	진행 상태
박도현	PATCH	Owner	🔗입장료 수정	/api/cafes/{cafeId}/fees/{feeId}	완료

🧷이미지 API 명세

담당자	Method	Role	기능	API path	진행 상태
김현정	DELETE	Admin	🔗유령 이미지 삭제	/api/images	완료

🧷프로그램 API 명세

담당자	Method	Role	기능	API path	진행 상태
김현정	POST	Owner	🔗키즈 카페 프로그램 추가	/api/cafes/{cafeId}/lessons	완료
김현정	GET	Owner	🔗키즈 카페 프로그램 조회	/api/cafes/{cafeId}/lessons	완료
김현정	PATCH	Owner	🔗키즈 카페 프로그램 수정	/api/lessons/{lessionId}	완료
김현정	DELETE	Owner	🔗키즈 카페 프로그램 삭제	/api/lessons/{lessonId}	완료

🧷쿠폰 API 명세

담당자	Method	Role	기능	API path	진행 상태
박도현	POST	Owner	🔗쿠폰 생성	/api/cafes/{cafeId}/coupons	완료
박도현	GET	User	🔗쿠폰 조회(사용자)	/api/users/coupons	완료
박도현	GET	Owner	🔗쿠폰 조회(사장님)	/api/owners/cafes/{cafeId}/coupons	완료
박도현	POST	Owner	🔗쿠폰 지급	/api/{couponId}/assign/{userId}	완료
박도현	POST	User	🔗쿠폰 사용	/api/{couponId}/use	완료

🗂️프로젝트 구조

'KidsCafe'
├── 'api'                     # API와 관련된 컨트롤러, 필터, 인터셉터, 외부 연동 로직
│   ├── 'auth'                # 인증 및 인증 관련 로직
│   │   ├── 'controller'      # 인증 요청을 처리하는 컨트롤러
│   │   ├── 'exception'       # 인증 관련 예외 처리
│   │   └── 'service'         # 인증 서비스 로직
│   ├── 'filter'              # 요청 필터 처리
│   ├── 'interceptor'         # 인터셉터를 통한 요청/응답 처리
│   ├── 'kakao'               # 카카오 API와의 연동
│   ├── 'naver'               # 네이버 API와의 연동
│   └── 'oauth2'              # OAuth2 인증 관련 모듈
│       ├── 'adapter'         # OAuth2 어댑터 구성
│       ├── 'config'          # OAuth2 설정
│       ├── 'controller'      # OAuth2 관련 요청 처리
│       ├── 'provider'        # OAuth2 제공자 설정
│       └── 'service'         # OAuth2 서비스 로직
├── 'common'                  # 공통 모듈 및 유틸리티
│   ├── 'annotation'          # 어노테이션 정의
│   ├── 'config'              # 공통 설정
│   ├── 'dto'                 # 공통적으로 사용되는 데이터 객체
│   ├── 'entity'              # 공통 엔티티 정의
│   ├── 'enums'               # 공통 Enum 정의
│   └── 'util'                # 공통 유틸리티
├── 'config'                  # 프로젝트 전체 설정
├── 'domain'                  # 비즈니스 도메인 모듈
│   ├── 'bookmark'            # 즐겨찾기 관리
│   ├── 'cafe'                # 카페 관련 도메인
│   ├── 'coupon'              # 쿠폰 관리
│   ├── 'fee'                 # 요금 관리
│   ├── 'image'               # 이미지 관리
│   ├── 'lesson'              # 레슨 관리
│   ├── 'pricepolicy'         # 가격 정책 관리
│   ├── 'recommend'           # 추천 시스템
│   ├── 'report'              # 신고 관리
│   ├── 'reservation'         # 예약 관리
│   ├── 'review'              # 리뷰 및 영수증 스캔
│   ├── 'room'                # 룸 정보 관리
│   └── 'user'                # 사용자 관리
├── 'dummy'                   # 테스트 데이터 생성
└── 'exception'               # 전역 예외 처리 및 예외 클래스