Skip to content

Feature Specification

hyoguoo edited this page Mar 31, 2024 · 1 revision

Rest API

End Point Method Description
/api/v1/auth/sign-in POST 로그인
/api/v1/auth/sign-up POST 회원가입
/api/v1/members/my GET 내 정보 조회
/api/v1/members/my/general PATCH 내 일반 정보 수정
/api/v1/members/my/password PATCH 내 비밀번호 수정
/api/v1/members/my/profile-image PATCH 내 프로필 이미지 수정
/api/v1/members/my/profile-image DELETE 내 프로필 이미지 삭제
/api/v1/rooms GET 모든 방 정보 조회
/api/v1/rooms POST 방 생성
/api/v1/rooms/{roomShortUuid} GET 개별 방 정보 조회
/api/v1/rooms/{roomShortUuid} PATCH 방 정보 수정
/api/v1/rooms/{roomShortUuid}/validate-enter POST 방 참여 전 검증
/api/v1/problems/html GET 문제 정보 조회(크롤링)
/api/v1/compile POST 코드 컴파일
/api/v1/solves/history GET 문제 풀이 히스토리 리스트 조회
/api/v1/solves/history/{solveId} GET 문제 풀이 히스토리 상세 조회
/api/v1/solves/result/{roomShortUuid} GET 문제 풀이 결과 조회
/api/v1/solves/submission POST 코드 제출
/api/v1/solves/submission-and-compile POST 코드 제출 및 테스트 케이스 컴파일

요청 및 응답에 대한 상세한 내용은 Swagger를 통해 정의한다.

WebSocket

Publication Endpoint Description
/publication/chat/enter 방 입장
/publication/chat/quit 방 퇴장
/publication/chat/message 메시지 전송
/publication/chat/ready 준비 상태로 변경
/publication/chat/unready 준비 해제 상태로 변경
/publication/chat/change-host 방장 변경
/publication/chat/start-coding 문제 풀이 시작
/publication/chat/end-coding 문제 풀이 종료
Clone this wiki locally