-
Notifications
You must be signed in to change notification settings - Fork 1
2.5. API 명세
kylekim2123 edited this page Nov 29, 2023
·
9 revisions
| 기능 | Method | Path |
|---|---|---|
| 사용자 OAuth 로그인 페이지 리다이렉트 | GET | /auth/{oauthProvider} |
| 사용자 로그인 (카카오) | GET | /auth/login/{oauthProvider}?authCode={authCode} |
| 사용자 AccessToken 갱신 | POST | /auth/refresh |
| 사용자 회원가입 (카카오) | POST | /members |
| 사용자 프로필 조회 | GET | /members/{memberId} |
| 사용자의 참여 확정 게스트 모집글 목록 조회 | GET | /members/{memberId}/games?status=확정 |
| 사용자가 만든 게스트 모집글 목록 조회 | GET | /members/{memberId}/created-games |
| 사용자가 가입한 크루 목록 조회 | GET | /members/{memberId}/crews?status=확정 |
| 사용자가 만든 크루 목록 조회 | GET | /members/{memberId}/created-crews |
| 사용자 로그아웃 | DELETE | /auth/logout |
| 회원의 게스트 모집 신청 여부 조회 | GET | /members/{memberId}/games/{gameId}/registration-status |
| 회원의 크루 가입 신청 여부 조회 | GET | /members/{memberId}/crews/{crewId}/registration-status |
| 기능 | Method | Path |
|---|---|---|
| 크루 생성 | POST | /crews |
| 크루 상세 조회 | GET | /crews/{crewId} |
| 크루 가입 신청 | POST | /crews/{crewId}/members |
| 크루원 가입 신청자 목록 조회 | GET | /crews/{crewId}/members?status=대기 |
| 크루원 가입 신청 수락 | PATCH | /crews/{crewId}/members/{memberId} |
| 크루원 가입 신청 거절/취소 | DELETE | /crews/{crewId}/members/{memberId} |
| 사용자 근처 크루 목록 조회 | GET | /crews?addressDepth1={addressDepth1}&addressDepth2={addressDepth2}&page={page}&size={size} |
| 기능 | Method | Path |
|---|---|---|
| 게스트 모집글 작성 | POST | /games |
| 조건별(장소, 날짜, 포지션별) 게스트 모집글 조회 | GET | /games?category={category}&value={value}&page={page}&size=&{size} |
| 게스트 모집글 상세 조회 | GET | /games/{gameId} |
| 게스트 모집 참여 신청 | POST | /games/{gameId}/members |
| 게스트 모집에 참여 신청된 혹은 확정된 사용자 정보 목록 조회 | GET | /games/{gameId}/members?status={status} |
| 게스트 모집 참여 신청 수락 | PATCH | /games/{gameId}/members/{memberId} |
| 게스트 모집 참여 신청 거절/취소 | DELETE | /games/{gameId}/members/{memberId} |
| 다른 사용자(호스트, 게스트) 매너 스코어 리뷰 | PATCH | /games/{gameId}/members/manner-scores |
| 기능 | Method | Path |
|---|---|---|
| 채팅 기능 소켓 통신 연결 | CONNECT | /chat |
| 특정 채팅방 구독 | SUBSCRIBE | /receive/rooms/{roomId} |
| 채팅방 입장 | SEND | /send/messages/enter/{roomId} |
| 채팅 메시지 전송 | SEND | /send/messages/talk/{roomId} |
| 채팅방 퇴장 | SEND | /send/messages/leave/{roomId} |
| 새 1:1 채팅방 생성 | POST | /rooms/personal |
| 특정 사용자와의 1:1 채팅방 존재 여부 조회 | GET | /rooms/personal?receiver={receiverId} |
| 채팅방 타입에 따른 참여중인 모든 채팅방 목록 조회 | GET | /rooms?type={type} |
| 단일 채팅방 정보 상세 조회 | GET | /rooms/{roomId} |
| 특정 채팅방의 모든 메시지 목록 조회 | GET | /messages/rooms/{roomId} |
| 기능 | Method | Path |
|---|---|---|
| 중심 좌표(위도, 경도)로 부터 특정 거리(M) 까지의 게스트 모집글 조회 | GET | /games/by-location?latitude={latitude}&longitude={longitude}&distance={distance} |
| 특정 지역의 게스트 모집글 조회 | GET | /games/by-address?addressDepth1={addressDepth1}&addressDepth2={addressDepth2} |
| 기능 | Method | Path |
|---|---|---|
| 크루 랭킹 조회 | GET | /ranking/crews |
| 기능 | Method | Path |
|---|---|---|
| 사용자 알람 연결 | GET | /alarms/subscribe |
| 로그인 된 사용자가 읽지 않은 알림 여부 조회 | GET | /alarms/unread |
| 크루 알람 읽음 여부 수정 요청 | PATCH | /crew-alarms/{crewAlarmId} |
| 게임 알람 읽음 여부 수정 요청 | PATCH | /game-alarms/{gameAlarmId} |
| 알림 목록 삭제 | DELETE | /alarms |
| 알림 목록 조회 | GET | /alarms?cursorId={cursorId}&size={size} |
| 기능 | Method | Path |
|---|---|---|
| 지역 목록 조회 | GET | /address |
| 포지션 목록 조회 | GET | /positions |