API Docs ‐ User

API Documentation

Endpoints

1. Save User

- 유저 등록

• Endpoint: /user

• Method: POST

• Request:

  • nickName : String
  • oauthId : String
  • accessToken : String
  • userImage : String

• Request Example:

{
    "nickName" : "유수현",
    "userImage" : "유수현 사진",
    "accessToken" : "Token!",
    "oauthId" : "oauthId!"
}

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

{
    "success": true,
    "message": "유저 등록 성공",
    "userId": "30dff0b5-5d89-41d4-bfef-bbfbbf249f4b"
}

• Response Failure Example

{
    "success": false,
    "message": "유저 등록 실패 시 DAO 저장 실패",
    "userId": null
}

2. Get User

- 유저 조회

• Endpoint: /user/{userId}
• Method: GET
• Request: : None
• Response:
  • success : Boolean
  • message : String
  • userInfo : User(userId, userImage, nickName)
    • userId : UUID (unique)
    • userImage : String
    • nickName : String
• Response Example:
• Response Success Example

{
    "success": true,
    "message": "유저 조회 성공",
    "userInfo": {
        "userId": "30dff0b5-5d89-41d4-bfef-bbfbbf249f4b",
        "userImage": "유수현 사진",
        "nickName": "유수현"
    }
}

• Response Failure Example

{
    "success": false,
    "message": "유저 조회 실패 시 DAO 검색 실패",
    "userInfo": null
}

3. Get User Login

- oauth를 통한 구글 로그인

• Endpoint: /user/login/oauth2/code/{registrationId}
• Method: GET
• Request: : None
• Response:
  • success : Boolean
  • message : String
  • userId : UUID
• Response Example:
• Response Success Example

{
    "success": true,
    "message": "구글 로그인 성공",
    "userId": "30dff0b5-5d89-41d4-bfef-bbfbbf249f4b",

}

• Response Failure Example

{
    "success": false,
    "message": "구글 로그인 실패",
    "userId": null
}