User

API Documentation

Endpoints

1. Get User

- 유저 프로필 조회

• EndPoint: /user/{userId}

• Method: GET

• Request: None

• Response:

  • success: Boolean
  • message: String
  • userInfo (userId, nickname, phoneNumber, createdAt)
    • userId: UUID (unique)
    • nickname: String
    • phoneNumber: String
    • createdAt: LocalDateTime

• Response Success Example:

{
    "userInfo": {
        "userId": "9f373112-8e93-4444-a403-a986f8bea4a3",
        "nickname": "유수현",
        "phoneNumber": "01041488137",
        "createdAt": "2025-01-24T22:03:02.567423"
    },
    "success": true,
    "message": "유저 프로필 조회 성공"
}

• Response failure Example:

{
    "userInfo": null,
    "success": false,
    "message": "유저 프로필 조회 실패"
}

2. Update User

- 유저 닉네임 수정

• Endpoint: /user

• Method: Put

• Request:

  • userId: UUID
  • nickname: String

• Request Example:

{
    "userId" : "8f373112-8e93-4444-a403-a986f8bea4a3",
    "nickname" : "임임정윤윤"
}

• Response:
  • success: Boolean
  • message: String
  • userId: UUID (unique)
• Response Success Example:

{
    "success": true,
    "message": "유저 닉네임 수정 성공",
    "userId": "8f373112-8e93-4444-a403-a986f8bea4a3"
}

• Response Fail Example:

{
    "success": false,
    "message": "유저 닉네임 수정 실패",
    "userId": null
}

3. Login User

- 유저 로그인

• Endpoint: /user/login

• Method: Get

• Request:

  • appleId: String
  • password: String

• Request Example:

{
    "appleId" : "dbtngus6",
    "password" : "1234"
}

• Response:
  • success: Boolean
  • message: String
  • userId: UUID (unique)
• Response Success Example:

{
    "success": true,
    "message": "유저 로그인 성공",
    "userId": "8f373112-8e93-4444-a403-a986f8bea4a3"
}

• Response Fail Example:

{
    "success": false,
    "message": "유저 로그인 실패",
    "userId": null
}