API Docs ‐ User(admin)

API Documentation

Endpoints

1. Login

- 로그인

• Endpoint: /admin/user/login
• Method: POST
• Request:
  • adminId : String
  • passWord : String
• Request Example:

Body

{
    "adminId": "test",
    "passWord": "testtest"
}

• Response:
  • success : Boolean
  • message : String
• Response Example:
• Response Success Example

{
    "success": true,
    "message": "user login success"
}

• Response Failure Example

{
    "success": false,
    "message": "user login failure"
}

2. Validation Check

- 유저 권한 확인

• Endpoint: /admin/user/role
• Method: POST
• Response:
  • success : Boolean
  • message : String
  • role : Boolean
• Response Example:
• Response Success Example (ADMIN일 경우 role = true, MEMBER일 경우 role = false)

{
    "role": true,
    "success": true,
    "message": "user exist"
}

• Response Failure Example

{
    "role": null,
    "success": false,
    "message": "doesn't user exist"
}

3. Logout

- 로그아웃

• Endpoint: /admin/user/logout
• Method: POST
• Response:
  • success : Boolean
  • message : String
• Response Example:
• Response Success Example

{
    "success": true,
    "message": "logout success"
}

• Response Failure Example

{
    "success": false,
    "message": "logout failure"
}

4. SaveUser

- 유저 생성

• Endpoint: /admin/user/join
• Method: POST
• Request:
  • adminName : String
  • adminId : String
  • passWord : String
  • role : String
  • category : String
• Request Example:

Body

{
    "adminName" : "개발테스트",
    "adminId" : "test",
    "passWord" : "testtest123",
    "role" : "ADMIN",
    "category" : "MAJOR"
}

• Response:
  • success : Boolean
  • message : String
  • userId : UUID
• Response Example:
• Response Success Example

{
    "success": true,
    "message": "user save success",
    "userId": "12345678-1234-1234-1234-123456789123"
}

• Response Failure Example

{
    "success": false,
    "message": "user save failure",
    "userId": "00000000-0000-0000-0000-000000000000"
}

5. UpdateUser

- 유저 수정

• Endpoint: /admin/user
• Method: PUT
• Request:
  • userId : UUID
  • adminName : String
  • adminId : String
  • passWord : String
  • role : String
  • category : String
• Request Example:

Body

{
    "userId": "12345678-1234-1234-1234-123456789123",
    "adminName": "개발테스트",
    "adminId": "test",
    "passWord": "testtest123",
    "role": "ADMIN",
    "category": "MAJOR"
}

• Response:
  • success : Boolean
  • message : String
  • userId : UUID
• Response Example:
• Response Success Example

{
    "success": true,
    "message": "user update success",
    "userId": "12345678-1234-1234-1234-123456789123"
}

• Response Failure Example

{
    "success": false,
    "message": "user update failure",
    "userId": "00000000-0000-0000-0000-000000000000"
}

6. DeleteUser

- 유저 삭제

• Endpoint: /admin/user
• Method: DELETE
• Request:
  • userId : UUID
• Request Example:

Body

{
    "userId": "12345678-1234-1234-1234-123456789123"
}

• Response:
  • success : Boolean
  • message : String
• Response Example:
• Response Success Example

{
    "success": true,
    "message": "user delete success"
}

• Response Failure Example

{
    "success": false,
    "message": "user delete failure"
}

7. GetUser

- 특정 유저 조회

• Endpoint: /admin/user
• Method: GET
• Request:
  • userId : UUID
• Request Example:

Param

{
    "userId": "12345678-1234-1234-1234-123456789123"
}

• Response:
  • success : Boolean
  • message : String
  • user : Object
    • userId : UUID
    • adminName : String
    • adminId : String
    • passWord : String
    • role : String
    • category : String
• Response Example:
• Response Success Example

{
    "success": true,
    "message": "success get user",
    "user": {
		 "userId": "12345678-1234-1234-1234-123456789123",
		 "adminName": "개발테스트",
	         "adminId": "test",
		 "passWord": "testtest123",
		 "role": "ADMIN",
		 "category": "MAJOR"
	    }
}

• Response Failure Example

{
    "success": false,
    "message": "doesn't exist user",
    "user": null
}

8. GetUsers

- 유저 전체 조회

• Endpoint: /admin/user/all
• Method: GET
• Response:
  • success : Boolean
  • message : String
  • userList : List
    • userId : UUID
    • adminName : String
    • adminId : String
    • passWord : String
    • role : String
    • category : String
• Response Example:
• Response Success Example

{
    "success": true,
    "message": "success get users",
    "userList": [
		    {
		         "userId": "12345678-1234-1234-1234-123456789123",
		         "adminName": "개발테스트",
	                 "adminId": "test",
		         "passWord": "testtest123",
		         "role": "ADMIN",
		         "category": "MAJOR"
	             },
		     ...
    ]
}

• Response Failure Example

{
    "success": false,
    "message": "doesn't exist user",
    "user": null
}

9. GetBoothIdByUser

- 유저 전체 조회

• Endpoint: /admin/user/booth
• Method: GET
• Response:
  • success : Boolean
  • message : String
  • boothId : UUID
• Response Example:
• Response Success Example

{
    "success": true,
    "message": "search success",
    "boohtId": "12345678-1234-1234-1234-123456789123"
}

• Response Failure Example

{
    "success": false,
    "message": "search failure",
    "boohtId": "00000000-0000-0000-0000-000000000000"
}