Sign up User

Request

• endpoint: POST /user/signup
• body

Key	Value	Type	Essential	Info
userId	gksxodnd	string(45byte)	true	아이디
passwd	dkgh12	string(200byte)	true	비밀번호
userName	한태웅	string(40byte)	true	이름
email	[email protected]	string(60byte)	true	이메일
birth	1994-05-20	string	true	생년월일
introduce	안녕 나는 코딩하는 오징어야	string(128byte)	true	자기소개

Response

Success

• status code: 200
• body

Key	Value	Type	Essential	Info
userId	gksxodnd	string(45byte)	true	아이디
userName	한태웅	string(40byte)	true	이름
email	[email protected]	string(60byte)	true	이메일
birth	1994-05-20	string	true	생년월일
introduce	안녕 나는 코딩하는 오징어야	string(128byte)	true	자기소개

Fail

• body

Key	Value	Type	Info
code	400	int	상태코드
message	bad request	string	에러메시지

Fail이 될 수 있는 경우

400 : BAD_REQUEST

• Essential한 파라미터가 없을 경우
• parameter 규격이 맞지 않을 경우 (ex. age : -1)

409 : DUPLICATED

• userId가 중복될 경우

500 : INTERNAL SERVER ERROR

Register Player nickname for game

request

• endpoint: POST /user/register/game
• body

Key	Value	Type	Essential	Info
nickname	Zookeeper	string(50byte)	true	게임 닉네임

response

Success

• status code: 200
• body

Key	Value	Type	Info
nickname	Zookeeper	string	플레이어의 닉네임
tier	BRONZE	string	플레이어의 티어
score	0	int	플레이어의 점수
history	data	json object	플레이어의 히스토리 정보
point	0	int	플레이어의 포인트

history data

Key	Value	Type	Info
win	0	int	승리 횟수
lose	0	int	패배 횟수
oneShot	0	int	한번에 적을 찾는 미션 달성 횟수
finder	0	int	짧은 시간안에 적을 찾는 미션 달성 횟수
lastWeekRank	0	int	플레이어의 랭크(ref: 한판도 실행하지 않았으면 0)

example

{
    "nickname": "zookeeper1",
    "tier": "BRONZE",
    "score": 0,
    "history": {
        "win": 0,
        "lose": 0,
        "oneShot": 0,
        "finder": 0,
        "lastWeekRank": 0
    },
    "weapon": [
        {
            "name": "hand",
            "damage": 0,
            "price": 0,
            "usableCount": 2147483647
        }
    ],
    "point": 0
}

Fail

• body

Key	Value	Type	Info
code	400	int	상태코드
message	bad request	string	에러메시지

Fail이 될 수 있는 경우

400 : BAD_REQUEST

• Essential한 파라미터가 없을 경우
• parameter 규격이 맞지 않을 경우

401 : UNAUTHORIZED

• header에 토큰값이 없거나 만료 되었을 경우

409 : DUPLICATED

• nickname이 중복될 경우

500 : INTERNAL SERVER ERROR

Sign in User

Request

• endpoint: POST /user/signin
• body

Key	Value	Type	Essential	Info
userId	gksxodnd	string(45byte)	true	아이디
passwd	dkgh12	string(200byte)	true	비밀번호

Response

Success

• status code: 204
• header

Key	Value	Type	Info
session-token	akjiodfj-asdkjf	string	세션토큰

Fail

• body

Key	Value	Type	Info
code	400	int	상태코드
message	bad request	string	에러메시지

Fail이 될 수 있는 경우

400 : BAD_REQUEST

• Essential한 파라미터가 없을 경우
• parameter 규격이 맞지 않을 경우 (ex. age : -1)

401 : UNAUTHORIZED

• 유저아이디가 존재하지 않을 경우
• 비밀번호가 틀렸을 경우

500 : INTERNAL SERVER ERROR

Sign out User

Request

• endpoint: GET /user/signout
• header

Key	Value	Type	Info
session-token	akjiodfj-asdkjf	string	세션토큰
userId	gksxodnd007	string	아이디

Response

Success

• status code: 204

Key	Value	Type	Info
expired-token	true	boolean	세션토큰폐기 확인

Fail

• body

Key	Value	Type	Info
code	500	int	상태코드
message	internal server error	string	에러메시지

Fail이 될 수 있는 경우

500 : INTERNAL SERVER ERROR

User ID 중복체크

Request

• endpoint: GET /user/checkDup/{userId}

Response

Success

• status code: 204
• header

Key	Value	Type	Info
isDup	true	boolean	중복유무

Fail

• body

Key	Value	Type	Info
code	400	int	상태코드
message	bad request	string	에러메시지

Fail이 될 수 있는 경우

400 : BAD_REQUEST

• path variable이 null일 경우

500 : INTERNAL SERVER ERROR

User 정보 조회

Request

• endpoint: GET /user/{userId}
• header

Key	Value	Type	Info
session-token	akjiodfj-asdkjf	string	세션토큰
userId	gksxodnd	string	로그인을 성공한 유저아이디

Response

Success

• status code: 200
• body

Key	Value	Type	Info
userId	gksxodnd	string	아이디
userName	한태웅	string	이름
nickname	zookeeper	string	플레이어 닉네임
email	[email protected]	string	이메일
birth	1994-05-20	date	생년월일
introduce	나는 코딩하는 오징어야	string	자기소개

nickname값이 0이면 플레이어를 등록하지 않은 경우이므로 등록하여야함

Fail

• body

Key	Value	Type	Info
code	400	int	상태코드
message	bad request	string	에러메시지

Fail이 될 수 있는 경우

400 : BAD_REQUEST

• path variable이 null인 경우

401 : UNAUTHORIZED

• header에 토큰값이 없거나 만료 되었을 경우

404 : NOT FOUND

• userId가 존재하지 않는 경우

500 : INTERNAL SERVER ERROR

User 정보 수정

Request

• endpoint: PUT /user/{userId}
• header

Key	Value	Type	Info
session-token	akjiodfj-asdkjf	string	세션토큰
userId	gksxodnd	string	로그인을 성공한 유저아이디

• body

Key	Value	Type	Essential	Info
userName	한태웅	string(45byte)	true	이름
passwd	dkgh12	string(200byte)	true	비밀번호
email	[email protected]	string(60byte)	true	이메일
birth	1994-05-20	string(yyyy-MM-dd)	true	생년월일
introduce	나는 코딩하는 오징어야	string(128byte)	true	자기소개

Response

Success

• status code: 200
• body

Key	Value	Type	Info
userId	gksxodnd	string	아이디
userName	한태웅	string	이름
email	[email protected]	string	이메일
birth	1994-05-20	date	생년월일
introduce	나는 코딩하는 오징어야	string	자기소개

Fail

• body

Key	Value	Type	Info
code	400	int	상태코드
message	bad request	string	에러메시지

Fail이 될 수 있는 경우

400 : BAD_REQUEST

• path variable이 null인 경우
• Essential한 파라미터가 없을 경우
• parameter 규격이 맞지 않을 경우 (ex. age : -1)

401 : UNAUTHORIZED

• header에 토큰값이 없거나 만료 되었을 경우

404 : NOT FOUND

• userId가 존재하지 않는 경우

500 : INTERNAL SERVER ERROR

User 삭제

request

• endpoint: DELETE /user/{userId}
• header

Key	Value	Type	Info
session-token	akjiodfj-asdkjf	string	세션토큰
userId	gksxodnd	string	로그인을 성공한 유저아이디

response

Success

• status code: 204

Fail

• body

Key	Value	Type	Info
code	400	int	상태코드
message	bad request	string	에러메시지

Fail이 될 수 있는 경우

400 : BAD_REQUEST

• path variable이 없을 경우

401 : UNAUTHORIZED

• header에 토큰값이 없거나 만료 되었을 경우

500 : INTERNAL SERVER ERROR