개요
이 문서는 사용자 관리 시스템의 REST API에 대한 명세서입니다. 이 API는 사용자 계정 생성, 인증, 점수 관리 등의 기능을 제공합니다.
기본 정보
- 기본 URL:
/users
- Content-Type:
application/json
- 세션 기반 인증: 로그인 후 세션을 통해 인증이 유지됩니다.
API 엔드포인트 요약
| 메서드 |
엔드포인트 |
설명 |
인증 필요 |
| GET |
/users |
기본 사용자 정보 |
아니오 |
| POST |
/users/signup |
회원 가입 |
아니오 |
| POST |
/users/signin |
로그인 |
아니오 |
| POST |
/users/signout |
로그아웃 |
예 |
| POST |
/users/score-update |
점수 업데이트 |
예 |
| GET |
/users/score |
점수 조회 |
예 |
| GET |
/leaderboard |
랭킹 조회 |
예 |
상태 코드
| 상태 코드 |
설명 |
| 200 |
성공 |
| 201 |
리소스 생성 성공 |
| 400 |
잘못된 요청 (클라이언트 오류) |
| 403 |
권한 없음 (로그인 필요) |
| 404 |
리소스를 찾을 수 없음 |
| 409 |
충돌 (이미 존재하는 리소스) |
| 500 |
서버 오류 |
응답 타입 상수
| 상수 |
값 |
설명 |
| INVALID_USERNAME |
0 |
존재하지 않는 사용자명 |
| INVALID_PASSWORD |
1 |
잘못된 비밀번호 |
| SUCCESS |
2 |
성공 |
API 세부 명세
기본 사용자 정보
| 항목 |
설명 |
| 메서드 |
GET |
| 엔드포인트 |
/users |
| 요청 본문 |
없음 |
| 성공 응답 |
respond with a resource |
회원 가입
| 항목 |
설명 |
| 메서드 |
POST |
| 엔드포인트 |
/users/signup |
| 요청 본문 |
JSON |
요청 필드:
| 필드 |
타입 |
필수 |
설명 |
| email |
string |
예 |
사용자 이메일 |
| password |
string |
예 |
비밀번호 |
| nickname |
string |
예 |
사용자 닉네임 |
| imageIndex |
integer |
아니오 |
프로필 이미지 인덱스 (기본값: 0) |
응답: