API 명세서 - Wo-oJin/Ari GitHub Wiki

필요한 API 목록 정리

권한 별 url 형식

  • /member ~: user, owner, admin 모두 허용
  • /user ~: user만 허용
  • /owner ~: owner만 허용
  • /admin ~: admin만 허용
  • 이외에는 비회원까지 모두 허용

인증 관련 :

회원가입

  • User 회원 가입 요청: POST /auth/signup-user
  • Owner 회원 가입 요청: POST /auth/signup-owner
  • Owner 가입코드 인증: POST /auth/signup-code
  • 이메일 중복검사: POST /auth/check-email
  • 이메일 인증코드 전송: POST /auth/email
  • 이메일 인증코드 검증: POST /auth/email-auth

로그인/로그아웃

  • 로그인 요청: POST /auth/login
  • jwt 토큰 reissue 요청: POST /auth/reissue
  • 로그아웃 요청: POST /auth/logout
  • 비밀번호 변경: POST /auth/change-password

마이 페이지:

  • 기존 가게정보 불러오기: GET /owner/update/store
  • 가게 정보 수정: POST /owner/update/store
  • 기존 이벤트 불러오기: GET /owner/private-event
  • 이벤트 추가: POST /owner/add/private-event
  • 이벤트 수정: POST /owner/update/private-event
  • 이벤트 삭제: POST /owner/delete/private-event
  • 가게 추가: POST /owner/add/store
  • 이벤트 갯수: POST /owner/event-num

메인 화면 :

  • 카테고리별 가게 불러오기 : GET /category?code="한식"
  • 전체 가게 불러오기 : GET /category?code="전체"
  • 모든 가게 조회: GET /map/all-stores
  • 키워드로 가게 검색(메인화면 검색창): GET /store?keyword="미스터쉐프"
  • 가게 상세 정보 조회 : GET /member/store/{store_id}
  • 랜덤 이벤트 불러오기 : GET /random-events

지도 화면 :

  • 가게 기본 정보 조회 : GET /map/all-stores
  • 가게 상세 정보 조회 : GET /map/store/{store_id}
  • 가게 찜 버튼 클릭 : POST /member/favorite/toggle?storeId=?
  • 현재 유저의 가게 찜 정보 조회: GET /member/like

게시판 :

  • 게시판 목록 조회 : GET /owner/board
  • 게시판 키워드 조회: GET /owner/board?keyword="abc"
  • 글 상세 조회: GET /owner/board/{article_id}
  • 글 작성 : POST /owner/board/write
  • 글 수정 : GET/PUT /owner/board/update/{id}
  • 글 삭제 : DELETE /owner/board/delete/{article_id}
  • 좋아요 게시글 목록 : GET /owner/board/like
  • 좋아요 버튼 클릭 : POST /owner/board/favorite/toggle?articleId={게시글_id}
  • 게시글 작성자가 소유한 모든 가게 이름 가져오기: GET /member/stores

협약 관련:

  • api 요청 가게(들)의 id/이름 조회: GET /owner/partnership/store-list
  • 제휴 요청: POST /owner/partnership/request
  • 받은 협약의 id와 발신 가게: GET /owner/partnership/received?storeId={대상 가게 id}
  • 보낸 협약의 id와 발신 가게: GET /owner/partnership/send?storeId={대상 가게 id}
  • 완료된 협약의 id와 가게 이름: GET /owner/partnership/completed?storeId={대상 가게 id}
  • 제휴 정보 확인: GET /owner/partnership/info?storeId={요청하는 가게 id}&partnershipId={대상 협약 id}
  • 협약 승인: POST /owner/partnership/approve?storeId={}&partnershipId={대상 협약 id}
  • 협약 거절: POST /owner/partnership/reject?storeId={}&partnershipId={대상 협약 id}
  • 새 요청 여부 확인 GET /owner/partnership/check/new-request

채팅:

  • 채팅 히스토리 조회 : GET /owner/chat/room
  • subscribe: /topic/public
  • 유저 입장: (STOMP) /app/chat/addUser
  • 유저 퇴장: (STOMP) /app/chat/exitUser
  • 채팅 전송: (STOMP) /app/chat/sendMessage

방문기록 관련

  • 방문기록 남기기: POST /user/history/record
  • 자신의 방문기록 확인: GET /member/history

공지사항 관련

  • 공지사항 게시글 저장: POST /admin/notice
  • 공지사항 게시글 수정: PUT /admin/notice/{noticeId}
  • 공지사항 게시글 삭제: DELETE /admin/notice/{noticeId}
  • 공지사항 게시글 목록 가져오기: GET /notice
  • 공지사항 게시글 상세 내용 가져오기: GET /notice/{noticeId}