User

회원 관리 요청

POST

회원 등록

POST URL/v1/users

새로운 회원을 등록합니다.

Request Body

Name	Type	Description
user_id*	String	아이디
phone_number*	String	전화번호
email*	String	이메일
role*	String	회원 등급
name*	String	이름

200 User successfully created

{
    "createdDate": "2022-06-23T20:06:58.204",
    "modifiedDate": "2022-06-23T20:06:58.204",
    "id": 1,
    "naverId": "1lOmnoQs0-GTI3XEOxmUOn1Fjm91IjLpyb4K7_kxzSM",
    "profileImage": "https://ssl.pstatic.net/static/pwe/address/img_profile.png",
    "gender": "M",
    "email": "[e-mail]",
    "mobile": "010-5913-xxxx",
    "mobileE164": "[phone]xxxx",
    "name": "이민재2",
    "role": "GUEST",
    "cardinalNumber": "NEW"
}

401 Permission denied

네이버 로그인 요청

POST URL/login

Request Body

Name	Type	Description
token*	String	네이버 토큰 값을 POST 요청하면 유저 프로필을 반환합니다.

200: OK

{
   {
      "createdDate": "2022-06-20T13:11:41",
      "modifiedDate": "2022-06-20T13:11:41",
      "id": 1,
      "naverId": "1lOmnoQs0-GTI3XEOxmUOn1Fjm91IjLpyb4K7_kxzSM",
      "profileImage": "https://ssl.pstatic.net/static/pwe/address/img_profile.png",
      "gender": "M",
       "email": "[e-mail]",
       "mobile": "010-5913-xxxx",
       "mobileE164": "[phone]xxxx",
       "name": "이민재",
       "role": "GUEST"
    } 
}

GET

전체 회원 조회

GET URL/v1/users

데이터베이스에 있는 모든 유저들을 조회합니다.

Query Parameters

Name	Type	Description
email	String	해당 이메일을 가진 유저를 조회합니다.
name	String	해당 이름을 가진 유저를 조회합니다.

200: OK

[
    {
        "createdDate": "2022-06-22T23:41:07.623",
        "modifiedDate": "2022-06-22T23:41:07.623",
        "id": 1,
        "naverId": null,
        "profileImage": null,
        "gender": "M",
        "email": "[e-mail]",
        "mobile": "010-5913-xxxx",
        "mobileE164": "[phone]xxxx",
        "name": "이민재",
        "role": "GUEST",
        "cardinalNumber": "NEW"
    },
    {
        "createdDate": "2022-06-22T23:41:08.399",
        "modifiedDate": "2022-06-22T23:41:08.399",
        "id": 2,
        "naverId": null,
        "profileImage": null,
        "gender": "M",
        "email": "[e-mail]",
        "mobile": "010-5913-0000",
        "mobileE164": "[phone]",
        "name": "이민재",
        "role": "GUEST",
        "cardinalNumber": "NEW"
    }
]

400: Bad Request

{
    // Response
}

PageNo는 1이면 1 -10, 2이면 11-20과 같이 페이지에 맞는 회원을 10개씩 가져옵니다.

회원 조회

GET URL/v1/users/{id}

id에 해당하는 회원을 조회합니다.

200: OK

{
    "profileImage": null,
    "gender": "M",
    "email": "[e-mail]",
    "mobile": "010-5913-xxxx",
    "name": "이민재",
    "role": "GUEST",
    "cardinalNumber": "NEW",
    "volunteers": [
        {
            "createdDate": "2022-07-01T15:33:21.247",
            "modifiedDate": "2022-07-01T15:33:21.247",
            "id": 1,
            "title": "봉사 제목",
            "content": "봉사 내용입니다.",
            "pictures": [],
            "volunteerDate": 1654408800,
            "applicationDate": 1654408800,
            "maximumPeople": 20,
            "currentPeople": 0
        }
    ]
}

400: Bad Request

{
    // Response
}

PATCH

회원 정보 변경

PATCH URL/v1/uers/{id}

id에 해당하는 회의 데이터를 변경합니다.

Request Body

Name	Type	Description
profileImage	String	프로필 이미지
email	String	이메일
role	String	회원 등급 (GUEST, USER, ADMIN)
cardinalNumber	String	기수
mobile	String	전화번호

200: OK

{
    "createdDate": "2022-06-23T20:06:58.204",
    "modifiedDate": "2022-06-23T20:06:58.204",
    "id": 1,
    "naverId": "1lOmnoQs0-GTI3XEOxmUOn1Fjm91IjLpyb4K7_kxzSM",
    "profileImage": "https://ssl.pstatic.net/static/pwe/address/img_profile.png",
    "gender": "M",
    "email": "[e-mail]",
    "mobile": "010-5913-xxxx",
    "mobileE164": "[phone]xxxx",
    "name": "이민재2",
    "role": "GUEST",
    "cardinalNumber": "NEW"
}

400: Bad Request

{
    // Response
}

DELETE

회원 삭제

DELETE URL/v1/users/{id}

회원의 정보를 데이터베이스에서 삭제합니다.

200: OK

{
    "createdDate": "2022-06-23T20:06:58.204",
    "modifiedDate": "2022-06-23T20:06:58.204",
    "id": 1,
    "naverId": "1lOmnoQs0-GTI3XEOxmUOn1Fjm91IjLpyb4K7_kxzSM",
    "profileImage": "https://ssl.pstatic.net/static/pwe/address/img_profile.png",
    "gender": "M",
    "email": "[e-mail]",
    "mobile": "010-5913-xxxx",
    "mobileE164": "[phone]xxxx",
    "name": "이민재2",
    "role": "GUEST",
    "cardinalNumber": "NEW"
}

400: Bad Request

{
    // Response
}