Skip to content

USER API

Kwon soon won edited this page Nov 3, 2020 · 1 revision

User API 개요

METHOD URL DESCRIPITION
GET /api/user 유저 전체 목록 가져오기
POST /api/user 유저 생성
PATCH /api/user/:userId 유저 imageUrl, name 업데이트
DELETE /api/user/:userId 유저 삭제하기

User list API

request

URL

GET /api/user

response

[
    {
        "id": 1,
        "email": "kyle@example.com",
        "imageUrl": null,
        "name": null,
        "createdAt": "2020-11-03T09:24:06.000Z",
        "updatedAt": "2020-11-03T09:24:06.000Z"
    },
    {
        "id": 2,
        "email": "suckstar@example.com",
        "imageUrl": null,
        "name": null,
        "createdAt": "2020-11-03T09:24:06.000Z",
        "updatedAt": "2020-11-03T09:24:06.000Z"
    },
]

User create API

request

URL

POST /api/user/:userId

Body

NAME TYPE DESCRIPITION REQUIRED
email String user email O
imageUrl String user profile image X
name String user name X

JSON example

{
    "email":"abc@a.com",
    "imageUrl":null,
    "name":"abc"
}

response

{
    "id": 5,
    "email": "abc@a.com",
    "imageUrl": null,
    "name": "abc",
    "updatedAt": "2020-11-03T13:33:56.106Z",
    "createdAt": "2020-11-03T13:33:56.106Z"
}

User update API

request

URL

PATCH /api/user/:userId

Body

NAME TYPE DESCRIPITION REQUIRED
imageUrl String user profile image X
name String user name X

JSON example

{
    "imageUrl":null,
    "name":"abc"
}

response

{
    "numOfaffectedRows":1
}

User delete API

request

URL

DELETE /api/user/:userId

response

{
    "numOfaffectedRows":1
}

Clone this wiki locally