Skip to content

사용자(Members) API

yanggwangseong edited this page Dec 13, 2024 · 6 revisions

Members

Method Endpoint Description
GET members/:memberId 특정 사용자 정보 가져오기
PATCH members/:memberId 특정 사용자 정보 수정
PATCH members/:memberId/profile-image 특정 사용자 프로필 이미지 수정
DELETE members/:memberId 특정 사용자 삭제
GET members/blacks 차단된 사용자 리스트 조회
POST members/blacks 특정 사용자를 차단
DELETE members/blacks/:blackId 특정 사용자를 차단 해제

[GET] 사용자 정보 조회 /members/:memberId

Headers

Key Value Description
Authorization Bearer jwt-access-token JWT 인증을 위한 액세스 토큰

Request

No request body required.

Response

Success (200 OK):

{
   "success": true,
   "data": {
       "memberId": "12345",
       "name": "John Doe",
       "nickname": "johnd",
       "email": "john.doe@example.com",
       "profileImage": "https://example.com/profile-image.jpg",
       "region": "Seoul",
       "mannerTemperature": 36.5,
       "createdAt": "2024-01-01T12:00:00Z",
       "updatedAt": "2024-11-19T12:00:00Z"
   }
}

Exception

  • 401 Unauthorized: 토큰이 없거나 유효하지 않은 경우
{
    "success": false,
    "timestamp": "2023-02-22T06:25:08.663Z",
    "status": 401,
    "message": "인증 토큰이 없거나 유효하지 않습니다",
    "path": "/members/12345"
}
  • 404 Not Found: 요청한 사용자를 찾을 수 없는 경우
{
    "success": false,
    "timestamp": "2023-02-22T06:25:08.663Z",
    "status": 404,
    "message": "사용자를 찾을 수 없습니다",
    "path": "/members/12345"
}

[PATCH] 특정 사용자 정보 수정 (/members/:memberId)

Headers

Key Value Description
Authorization Bearer jwt-access-token JWT 인증을 위한 액세스 토큰

Request

{
    "name": "yang",
    "nickname": "yang",
    "region": "Busan"
}

Response

Success (200 OK):

{
   "success": true,
   "data": {
       "memberId": "12345",
       "name": "Yang Doe",
       "nickname": "yang",
       "region": "Busan",
       "updatedAt": "2024-11-19T13:00:00Z"
   }
}

Exception

  • 400 Bad Request: 필수 필드가 누락되거나 유효하지 않은 경우
{
    "success": false,
    "timestamp": "2023-02-22T06:25:08.663Z",
    "status": 400,
    "message": "필수 필드가 누락되었거나 유효하지 않습니다",
    "path": "/members/12345"
}
  • 401 Unauthorized: 인증되지 않은 사용자가 요청한 경우
{
    "success": false,
    "timestamp": "2023-02-22T06:25:08.663Z",
    "status": 401,
    "message": "인증 토큰이 없거나 유효하지 않습니다",
    "path": "/members/12345"
}
  • 403 Forbidden: 사용자가 권한이 없는 정보를 수정하려는 경우
{
    "success": false,
    "timestamp": "2023-02-22T06:25:08.663Z",
    "status": 403,
    "message": "해당 정보를 수정할 권한이 없습니다",
    "path": "/members/12345"
}
  • 404 Not Found: 요청한 사용자를 찾을 수 없는 경우
{
    "success": false,
    "timestamp": "2023-02-22T06:25:08.663Z",
    "status": 404,
    "message": "사용자를 찾을 수 없습니다",
    "path": "/members/12345"
}

[PATCH] 특정 사용자 프로필 이미지 수정 /members/:memberId/profile-image

Headers

Key Value Description
Authorization Bearer jwt-access-token JWT 인증을 위한 액세스 토큰
Content-Type multipart/form-data 파일 업로드를 위한 헤더 설정

Request (Form-Data)

{
   "profileImage": "file"
}

Response

Success (200 OK):

{
   "success": true,
   "data": {
       "memberId": "12345",
       "profileImage": "https://example.com/uploads/new-profile-image.jpg",
       "updatedAt": "2024-11-19T13:15:00Z"
   }
}

Exception

  • 400 Bad Request: 필수 필드 누락 또는 유효하지 않은 파일 형식
{
    "success": false,
    "timestamp": "2023-02-22T06:25:08.663Z",
    "status": 400,
    "message": "프로필 이미지가 유효하지 않거나 누락되었습니다",
    "path": "/members/12345/profile-image"
}
  • 401 Unauthorized: 인증되지 않은 사용자가 요청한 경우
{
    "success": false,
    "timestamp": "2023-02-22T06:25:08.663Z",
    "status": 401,
    "message": "인증 토큰이 없거나 유효하지 않습니다",
    "path": "/members/12345/profile-image"
}
  • 404 Not Found: 요청한 사용자를 찾을 수 없는 경우
{
    "success": false,
    "timestamp": "2023-02-22T06:25:08.663Z",
    "status": 404,
    "message": "사용자를 찾을 수 없습니다",
    "path": "/members/12345/profile-image"
}
Clone this wiki locally