API docs by Redocly

OpenAPI definition (v0)

Download OpenAPI specification:

game-controller

게임 정보 수정

기존에 생성된 게임의 정보를 수정합니다.

path Parameters
gameId
required
integer <int64>
Request Body schema: application/json
required
referencedRuleId
integer <int64>
ruleDescription
required
string [ 1 .. 500 ] characters
pointsToWin
integer <int32> >= -1
setsToWin
integer <int32> >= 1
duration
integer <int32> >= -1
winBy
required
string
matchDate
string <date-time>
placeRoad
string
placeDetail
string

Responses

Request samples

Content type
application/json
{
  • "referencedRuleId": 0,
  • "ruleDescription": "string",
  • "pointsToWin": -1,
  • "setsToWin": 1,
  • "duration": -1,
  • "winBy": "string",
  • "matchDate": "2019-08-24T14:15:22Z",
  • "placeRoad": "string",
  • "placeDetail": "string"
}

Start Game

경기 주최자가 해당 게임을 시작 상태로 변경합니다.

path Parameters
id
required
integer <int64>

Responses

게임 참가 신청

현재 로그인한 사용자가 해당 게임에 참가 신청을 보냅니다.

path Parameters
gameId
required
integer <int64>

Responses

Create Custom Game

사용자가 커스텀한 스포츠 경기를 생성합니다.

Request Body schema: application/json
required
referencedRuleId
integer <int64>
ruleDescription
required
string [ 1 .. 500 ] characters
pointsToWin
integer <int32> >= -1
setsToWin
integer <int32> >= 1
duration
integer <int32> >= -1
winBy
required
string
matchDate
string <date-time>
placeRoad
string
placeDetail
string

Responses

Request samples

Content type
application/json
{
  • "referencedRuleId": 0,
  • "ruleDescription": "string",
  • "pointsToWin": -1,
  • "setsToWin": 1,
  • "duration": -1,
  • "winBy": "string",
  • "matchDate": "2019-08-24T14:15:22Z",
  • "placeRoad": "string",
  • "placeDetail": "string"
}

게임 신청 취소

지원자가 게임 신청을 취소합니다.

Request Body schema: application/json
required
gameId
required
integer <int64>

Responses

Request samples

Content type
application/json
{
  • "gameId": 0
}

참가 승인 취소

참가자의 승인을 취소합니다.

Request Body schema: application/json
required
gameId
required
integer <int64>
userId
required
integer <int64>

Responses

Request samples

Content type
application/json
{
  • "gameId": 0,
  • "userId": 0
}

참가 신청 승인

특정 게임에 지원한 사용자의 참가 신청을 승인합니다.

Request Body schema: application/json
required
gameId
required
integer <int64>
userId
required
integer <int64>

Responses

Request samples

Content type
application/json
{
  • "gameId": 0,
  • "userId": 0
}

게임 참가자 승인

방장이 특정 참가자의 신청을 승인합니다.

path Parameters
participationId
required
integer <int64>

Responses

게임 결과 조회

지정한 게임의 최종 결과를 반환합니다.

path Parameters
gameId
required
integer <int64>

Responses

참가 신청 ID 조회

gameId와 email로 참가 신청 엔티티의 ID를 조회합니다.

path Parameters
gameId
required
integer <int64>
email
required
string

Responses

게임 간략 정보 조회

게임 ID를 기반으로 간략한 게임 정보를 반환합니다.

query Parameters
gameId
required
integer <int64>

Responses

내가 신청한 게임 목록 조회

현재 로그인한 사용자가 참가 신청한 게임 목록(요약)을 반환합니다.

Responses

내 게임 전체 조회

내가 참가자로 속한 모든 게임 정보를 반환합니다. (진행 예정, 완료 포함)

Responses

내가 생성한 게임에 지원한 유저 목록 조회

로그인한 사용자가 만든 게임에 신청한 유저 정보를 그룹별로 조회합니다.

Responses

게임 리스트 조회

현재 참여 가능한 모든 게임 방의 요약 정보(제목, 카테고리, 간략 설명 등)를 반환합니다.

Responses

Get In-Progress Game

현재 로그인 유저의 진행 중 게임 정보를 반환합니다.

Responses

게임 나가기

현재 로그인한 사용자를 해당 게임에서 제외합니다.

path Parameters
gameId
required
integer <int64>

Responses

게임 삭제

사용자가 본인이 생성한 게임을 삭제합니다.

path Parameters
gameId
required
integer <int64>

Responses

comment-controller

Get Comments

게임 ID에 해당하는 모든 댓글을 조회합니다.

path Parameters
gameId
required
integer <int64>

Responses

Add Comment

특정 게임에 댓글을 작성합니다.

path Parameters
gameId
required
integer <int64>
Request Body schema: application/json
required
content
required
string

Responses

Request samples

Content type
application/json
{
  • "content": "string"
}

auth-controller

사용자 회원가입

이메일, 비밀번호, 닉네임을 받아 신규 사용자를 생성합니다.

Request Body schema: application/json
required
email
required
string [ 0 .. 50 ] characters
password
required
string [ 8 .. 20 ] characters
nickname
required
string [ 2 .. 30 ] characters

Responses

Request samples

Content type
application/json
{
  • "email": "string",
  • "password": "stringst",
  • "nickname": "string"
}

사용자 로그인

이메일과 비밀번호를 받아 로그인 후 JWT 토큰을 발급합니다.

Request Body schema: application/json
required
email
required
string [ 0 .. 50 ] characters
password
required
string [ 8 .. 20 ] characters

Responses

Request samples

Content type
application/json
{
  • "email": "string",
  • "password": "stringst"
}

getCurrentUserId

Responses

user-profile-controller

사용자 프로필 저장

나이, 성별, 지역, 자기소개, 프로필 사진을 저장하거나 수정합니다. *이 request는 multipart/form-data 입니다.

Request Body schema: application/json
object (UserProfileRequest)
profile_picture
string <binary>

Responses

Request samples

Content type
application/json
{
  • "request": {
    },
  • "profile_picture": "string"
}

rule-controller

사용자 규칙 목록 조회

현재 로그인한 사용자가 만든 규칙 목록을 반환합니다.

Responses

game-play-controller

getGameLogs

path Parameters
id
required
integer <int64>

Responses

getDetail

path Parameters
id
required
integer <int64>

Responses

chat-room-controller

getChatMessages

path Parameters
roomId
required
string <uuid>

Responses

getChatRoomIdByGameId

path Parameters
gameId
required
integer <int64>

Responses