Closed WooSeob closed 2 years ago
/auth/login POST
POST
Request Body
{ userId: string password: string }
Response
성공시
status 200
status
Body
{sessionId: string}
실패시
선택한 카테고리에 대한 Match 목록을 구독합니다.
Namespace : "/match"
Namespace
Authentication : auth : {token : 로그인 성공시 받은 token값}
Authentication
로그인 성공시 받은 token값
SectionType : "Narae" | "Hoyoen" | "Changzo" | "Bibong"
SectionType
CategoryType : "korean" | "chinese" | "japanese" | "western" | "porkcutlet" | "chicken" | "pizza" | "ddeock" | "fastfood"
CategoryType
"create"
새로운 Match를 생성한다. 성공 시 클라이언트 측의 화면은 매치 목록 화면에서 해당 매치 화면으로 전환되어야 한다.
MessageBody :
MessageBody
// src/match/dto/request/create-match.dto.ts { userId: string; shopName: string; deliveryPriceAtLeast: number; deliveryTipsInterval: {price: number, tip: number}[]; category: CategoryType; section: SectionType; }
수정 예정
"subscribe"
category 에 해당하는 match 목록을 구독한다. 각 match는 고유한 id를 가지며 변동 사항(create, update, delete)이 발생할 시 서버 측에서 메시지를 송신한다.
category
해당 이벤트에 대한 ack로 기존 방 목록 정보를 전달한다.
// src/match/dto/request/subscribe-category.dto.ts { userId: string category: CategoryType }
{ status: number, data: { // src/match/dto/response/match-info.dto.ts id: string; shopName: string; section: string; total: number; tip: number; }[] }
"new-arrive"
구독 중인 카테고리에 새로운 Match가 생성될 때 송신한다.
클라이언트 측에서는 기존 목록에 해당 Match를 추가해야 한다.
{ // src/match/dto/response/match-info.dto.ts id: string; shopName: string; section: string; total: number; tip: number; }
"closed"
기존에 모집 중이던 Match가 종료된 경우 송신한다. (모집 마감, 중도 폐쇄)
클라이언트 측에서는 기존 목록에서 해당 Match를 제거해야 한다.
"update"
기존 목록에 존재하던 Match에 수정사항이 생긴 경우에 송신한다.
클라이언트 측에서는 기존 목록 중 해당 Match를 송신 받은 데이터로 수정해야 한다.
"join"
// src/match/dto/request/join-match.dto.ts { userId: string; matchId: string; }
Auth - RestAPI
/auth/login
POST
Request Body
Response
성공시
status
200Body
실패시
status
401Match - Socket.io namespace
Overview
선택한 카테고리에 대한 Match 목록을 구독합니다.
Namespace
: "/match"Authentication
: auth : {token :로그인 성공시 받은 token값
}Interface
SectionType
: "Narae" | "Hoyoen" | "Changzo" | "Bibong"CategoryType
: "korean" | "chinese" | "japanese" | "western" | "porkcutlet" | "chicken" | "pizza" | "ddeock" | "fastfood"Event
"create"
새로운 Match를 생성한다. 성공 시 클라이언트 측의 화면은 매치 목록 화면에서 해당 매치 화면으로 전환되어야 한다.
MessageBody
:수정 예정
"subscribe"
category
에 해당하는 match 목록을 구독한다. 각 match는 고유한 id를 가지며 변동 사항(create, update, delete)이 발생할 시 서버 측에서 메시지를 송신한다.해당 이벤트에 대한 ack로 기존 방 목록 정보를 전달한다.
"new-arrive"
구독 중인 카테고리에 새로운 Match가 생성될 때 송신한다.
클라이언트 측에서는 기존 목록에 해당 Match를 추가해야 한다.
"closed"
기존에 모집 중이던 Match가 종료된 경우 송신한다. (모집 마감, 중도 폐쇄)
클라이언트 측에서는 기존 목록에서 해당 Match를 제거해야 한다.
"update"
기존 목록에 존재하던 Match에 수정사항이 생긴 경우에 송신한다.
클라이언트 측에서는 기존 목록 중 해당 Match를 송신 받은 데이터로 수정해야 한다.
"join"
수정 예정