api-role-spec.md

Auth API

• USER, OWNER, MASTER, MANAGER는
  • 로그인 / 로그아웃 할 수 있다.
  • RefreshToken으로 새로운 AccessToken을 발급받을 수 있다.

Admin API (MASTER, MANAGER)

• 사용자 상태 변경을 할 수 있다. (ACTIVE, BANNED, WITHDRAWN)
• 사용자 목록 / 상세 정보를 조회 할 수 있다.
• 사용자를 강제로 탈퇴 처리할 수 있다.
• 탈퇴(WITHDRAWN) 상태의 사용자 목록을 조회할 수 있다.
• 제재(BANNED) 상태의 사용자 목록을 조회할 수 있다.

User API

• USER는

  • 일반 회원가입을 할 수 있다.

• OWNER는

  • 오너 회원가입을 할 수 있다.

• MASTER는

  • 마스터 회원가입을 할 수 있다. (관리자 승인 필요)
  • 승인 대기 중인 사용자 목록을 조회할 수 있다.
  • 승인 대기 중인 사용자를 승인 또는 거부 할 수 있다.

• MANAGER는

  • 매니저 회원가입을 할 수 있다. (관리자 승인 필요)

• 로그인한 사용자(USER, OWNER, MASTER, MANAGER)는

  • 내 정보를 조회 / 수정할 수 있다.
  • 자신의 비밀번호를 변경할 수 있다.
  • 회원 탈퇴를 할 수 있다. (본인만 가능)

Address API

• USER, OWNER, MASTER, MANAGER는
  • 배송지를 최대 10개까지 등록할 수 있다.
  • 자신의 모든 배송지 목록을 조회할 수 있다.
  • 자신의 배송지를 상세 조회할 수 있다.
  • 자신의 배송지를 수정 / 삭제할 수 있다.
  • 자신의 기본 배송지를 설정 / 조회할 수 있다.

AI API

• USER, OWNER, MASTER, MANAGER는
  • AI를 통해 메뉴 설명을 생성할 수 있다.

Store API

• USER는

  • 운영중인 가게를 상세 / 목록 조회할 수 있다.
  • 키워드 검색 결과를 통해 운영중인 가게를 목록 조회할 수 있다.

• ONWER는

  • 1개의 가게만 생성할 수 있다.
  • 자신이 생성한 가게를 수정 / 삭제할 수 있다.

• OWNER, MASTER, MANAGER는

  • 삭제되지 않은 가게를 상세 / 목록 조회할 수 있다. (휴업중인 가게도 조회 가능)
  • 키워드 검색 결과를 통해 삭제되지 않은 가게를 목록 조회할 수 있다. (휴업중인 가게도 조회 가능)

Category API

• USER는

  • 삭제되지 않은 가게를 카테고리별 목록 조회할 수 있다.

• MASTER, MANAGER는

  • 카테고리를 생성할 수 있다.
  • 카테고리명을 기존에 없는 이름으로 수정할 수 있다.

• OWNER, MASTER, MANAGER는

  • 삭제되지 않은 가게를 카테고리별 목록 조회할 수 있다. (휴업중인 가게도 조회 가능)

Menu API

• USER는

  • 가게의 비활성화, 삭제되지 않은 메뉴 목록을 조회할 수 있다.
  • 가게의 특정 메뉴를 조회할 수 있다.
  • 가게의 특정 메뉴에 대한 비활성화, 삭제되지 않은 옵션/옵션값 목록을 조회할 수 있다.

• OWNER는

  • 운영중인 자신의 가게 메뉴를 생성할 수 있다.
  • 운영중인 자신의 가게의 삭제되지 않은 메뉴를 수정 / 삭제할 수 있다.
  • 운영중인 자신의 가게 메뉴에 대한 옵션을 생성 / 수정 / 삭제할 수 있다.
  • 운영중인 자신의 가게 메뉴 옵션에 대한 옵션값을 생성 / 수정 / 삭제할 수 있다.
  • 자신의 가게의 특정 메뉴를 조회할 수 있다. (비활성화된 메뉴도 조회 가능)
  • 다른 가게의 특정 메뉴를 조회할 수 있다.
  • 자신의 가게의 삭제되지 않은 메뉴 목록을 조회할 수 있다. (비활성화된 메뉴도 조회 가능)
  • 자신의 가게의 메뉴에 대한 삭제되지 않은 옵션/옵션값 목록을 조회할 수 있다.

• MASTER, MANAGER는

  • 가게의 메뉴를 생성 / 삭제할 수 있다.
  • 가게 메뉴에 대한 옵션 / 옵션값을 생성할 수 있다.
  • 가게의 특정 메뉴를 조회할 수 있다. (비활성화된 메뉴도 조회 가능)
  • 가게의 모든 메뉴 목록을 조회할 수 있다. (비활성화, 삭제된 메뉴도 조회 가능)
  • 가게의 메뉴에 대한 삭제되지 않은 옵션 / 옵션값 목록을 조회할 수 있다.

• USER, OWNER, MASTER, MANAGER는

  • 키워드 검색 결과를 통해 특정 가게의 활성화된 메뉴의 목록을 조회할 수 있다.

Order API

• USER, MASTER, MANAGER는

  • 주문을 생성할 수 있다. (created)
  • 주문을 취소할 수 있다. (created, pengding -> canceled)
  • USER의 주문 내역을 조회할 수 있다.

• OWNER, MASTER, MANAGER는

  • 주문을 수락할 수 있다. (pending -> accept)
  • 주문을 거절할 수 있다. (pending -> reject)
  • 배송 준비로 주문의 상태를 변경할 수 있다. (accept -> ready)
  • 배달중으로 주문의 상태를 변경할 수 있다. (ready -> delivering)
  • 음식 배송지에서 수락 완료로 주문의 상태를 변경할 수 있다. (delivering -> complete)
  • 가게가 받은 주문 내역을 조회할 수 있다.

• USER, OWNER, MASTER, MANAGER는

  • 특정 주문 정보를 조회를 할 수 있다.

Payment API

• USER는

  • 결제를 생성할 수 있다.

• OWNER, MASTER, MANAGER는

  • 완료된 결제를 환불 처리할 수 있다.
  • 특정 결제 정보를 조회할 수 있다.

Review API

• USER는

  • 주문 완료 후 가게에 대한 리뷰를 작성할 수 있다.
  • 자신이 작성한 리뷰를 삭제할 수 있다.
  • 자신이 작성한 리뷰 목록을 조회할 수 있다.

• MASTER, MANAGER는

  • USER가 작성한 리뷰를 삭제할 수 있다.

• USER, OWNER, MASTER, MANAGER는

  • 특정 가게의 리뷰 목록을 조회할 수 있다.