API_Docs.md

API Documents

목차

• User, 유저 인증
  • Sign Up
  • Sign In
  • Sign Out
  • Check Duplicate Email
  • Check Duplicate Nickname
  • Get Info
• Battle, 전투
  • Start
  • Result
• Ranking, 랭킹
  • Leader Board
  • Player Ranking
• Models
  • UserResponseDto Model

User, 유저 인증

POST - Sign Up

~/user/sign-up

입력받은 정보로 회원가입을 진행합니다. 성공 여부를 반환합니다.

Parameters

Key	Type	Description
email	String	이메일
password	String	비밀번호
nickname	String	닉네임

Response

Key	Type	Description
result	Boolean	회원가입 성공 여부

POST - Sign In

~/user/sign-in

입력받은 이메일과 비밀번호로 로그인을 진행합니다. 로그인 성공시 유저 정보를 반환합니다. 로그인 실패시 에러를 반환합니다.

Parameters

Key	Type	Description
email	String	이메일
password	String	비밀번호

Response

Key	Type	Description
id	String	고유 ID
nickname	String	닉네임
score	int	점수
win	int	승리
lose	int	패배
draw	int	무승부
ranking	int	랭킹

POST - Sign Out

~/user/sign-out

로그아웃을 진행합니다.

Parameters

None

Response

Key	Type	Description
result	Boolean	로그아웃 성공 여부

GET - Check Duplicate Email

~/user/duplicate-email

입력된 이메일이 이미 존재하는 경우 true를 반환합니다. 존재하지 않는 경우 false를 반환합니다.

Parameters

Key	Type	Description
email	String	사용할 이메일

Response

Key	Type	Description
result	Boolean	입력으로 받은 이메일의 존재 여부

GET - Check Duplicate Nickname

~/user/duplicate-nickname

입력된 닉네임이 이미 존재하는 경우 true를 반환합니다. 존재하지 않는 경우 false를 반환합니다.

Parameters

Key	Type	Description
nickname	String	사용할 닉네임

Response

Key	Type	Description
result	Boolean	입력으로 받은 닉네임의 존재 여부

GET - Get Info

~/user/{id}

요청 받은 id 값에 따른 유저의 정보를 반환합니다.

Parameters

None

Response

Key	Type	Description
id	String	고유 ID
nickname	String	닉네임
score	int	점수
win	int	승리
lose	int	패배
draw	int	무승부
ranking	int	랭킹

Battle, 전투

POST - Start

~/battle/start

전투 시작시 탈주 또는 강제종료를 고려하여 미리 점수를 낮춥니다.

Parameters

None

Response

Key	Type	Description
result	Boolean	결과

POST - Result

~/battle/result

전투 결과를 저장합니다.

Parameters

Key	Type	Description
result	BattleResult	전투 결과

Response

Key	Type	Description
id	String	고유 ID
nickname	String	닉네임
score	int	점수
win	int	승리
lose	int	패배
draw	int	무승부
ranking	int	랭킹

Ranking, 랭킹

GET - Leader Board

~/ranking/leader-board

페이지에 따른 상위 랭커 정보를 반환합니다.

Parameters

Key	Type	Description
page	int	페이지

Response

Key	Type	Description
users	Array<UserResponseDto>	상위 랭킹 유저들의 정보 배열
totalCount	long	총 유저 수

GET - Player Ranking

~/ranking/player-ranking

사용자의 랭킹을 반환합니다.

Parameters

None

Response

Key	Type	Description
ranking	int	랭킹

Models

UserResponseDto Model

유저 정보 반환용 모델

Key	Type	Description
id	String	고유 ID
nickname	String	닉네임
score	int	점수
win	int	승리
lose	int	패배
draw	int	무승부
ranking	int	랭킹