api 변경

[WooSeob]

/Room

기존에 없지만 새로 추가된 API

• GET /room/:rid/state
  • 해당 방의 상태정보를 가져옴
• GET /room/:rid/participants
  • 해당 방의 참여자 정보를 가져옴
• GET /room/:rid/kick
  • Query Parameter
  • uid : userId(string)
  • uid 에 해당하는 유저를 강퇴시킴
  • 해당 방의 방장 && prepare 단계에서 수행됨.
• POST /room/:rid/purchase-screenshot
  • Multipart Name : "purchase_screenshot"
  • 결제 이미지를 업로드함
• GET /room/:rid/purchase-screenshot
  • 결제 이미지를 다운로드함
• GET /room/:rid/receipt
  • 개개인의 order check 결과를 가져옴

변경된 API

• GET /room/:rid/menus

  • response json 타입 아래와 같이 변경됨.

  [
    {
      "user": {
        "userId": "string",
        "name": "string"
      },
      "menus": [
        {
          "id": "string",
          "name": "string",
          "quantity": 0,
          "description": "string",
          "price": 0
        }
      ]
    }
  ]

• POST /room/:rid/vote

  • CreateVoteDto를 통해 type("kick" or "reset")과 target_uid(타겟 유저 아이디)를 받던것에서
  1. POST /room/:rid/vote-kick?targetId="uid"
  2. POST /room/:rid/vote-reset

  으로 분할함. 1번의 쿼리 파라메터 targetId 는 해당 타겟 유저 아이디

• POST /room/:rid/vote/:vid

  • DoVoteDto를 통해 agree: boolean 을 받던 것에서 쿼리스트링 isAgree: boolean 을 받는것으로 변경함
  • -> POST /room/:rid/vote/:vid?isAgree=true

• POST /room/:rid/order-check

  • CheckOrderDto를 통해 multipart image와 배달팁 tip: integer를 받던것에서 쿼리스트링 delivery-tip: integer 를 받는것으로 변경함
  • 이미지 업로드 API를 분리했기 때문에 order-check 하기 위해서 아래 두단계를 순차적으로 수행해야함
    1. POST /room/:rid/purchase-screenshot 를 통해서 이미지를 업로드 함.
    2. 해당API인 POST /room/:rid/order-check를호출

/User

기존에 없지만 새로 추가된 API

• /user/:uid/profile

  • 해당 유저의 정보를 가져옴
  • {id: string, name: string}

• /user/:uid/rooms

  • 해당 유저의 참여 방 리스트를 불러옴

  • [
    {
        id: string
        purchaserId: string,
        shopName: string,
        state: integer(0: prepare, 1: orderFix, 2:orderCheck, 3:orderDone),
        role: string ("purchaser", "member")
        isReady: boolean,
    }
    ]

변경된 API

• GET /user/:uid/room/:rid/ready
  • 호출시마다 레디 상태를 변경하고 리턴하던것에서 쿼리스트링 state: boolean 을 받는것으로 변경함
  • -> GET /user/:uid/room/:rid/ready?state=true

/Match

변경된 API

• /match/:matchId/join

  • 방 정보를 반환하도록 수정함

  • {
        id: string
        purchaserId: string,
        shopName: string,
        state: integer(0: prepare, 1: orderFix, 2:orderCheck, 3:orderDone),
        role: string ("purchaser", "member")
        isReady: boolean,
    }