User API - mash-up-kr/real-backend GitHub Wiki

name method url
νšŒμ› κ°€μž… POST /auth/register/
둜그인 POST /auth/login/
νšŒμ› 쑰회 GET /auth/user/
νšŒμ› 정보 μˆ˜μ • PATCH /auth/user/
νšŒμ› νƒˆν‡΄ DELETE /auth/user/

νšŒμ› κ°€μž…

name method url description
νšŒμ› κ°€μž… POST /auth/register/ μƒˆ νšŒμ› μΆ”κ°€

Request

Body

Name Data Type Required Default Value Description
email String true - 이메일(username으둜 μ‚¬μš©)
password String true - λΉ„λ°€λ²ˆν˜Έ
nickname String true - λ‹‰λ„€μž„ 
{
    "email": "test@naver.com",
    "password": "test",
    "nickname": "test"
}

Response

Body

Name Data Type Number Description
user User 1 -
token String 1 - 
{
    "user": {
        "nickname": "test",
        "email": "test@naver.com"
    },
    "token": "d72933d5c58d80f36d944583bca4bf3ac941999835a39dc0b53e3b0878d7e527"
}

둜그인

name method url description
둜그인 POST /auth/login/ λ‘œκ·ΈμΈν•˜μ—¬ 토큰 μ–»κΈ°

Request

Body

Name Data Type Required Default Value Description
email String true - 이메일
password String true - λΉ„λ°€λ²ˆν˜Έ 
{
    "email": "test@naver.com",
    "password": "test"
}

Response

Body

Name Data Type Number Description
user User 1 -
token String 1 - 
{
    "user": {
        "nickname": "test",
        "email": "test@naver.com"
    },
    "token": "d72933d5c58d80f36d944583bca4bf3ac941999835a39dc0b53e3b0878d7e527"
}

νšŒμ› 쑰회

name method url description
꿈 쑰회 GET /auth/user/ 토큰에 λ”°λ₯Έ νšŒμ› 정보 쑰회

Request

Header

Header Name Required Default Value Description
Authorization true - 둜그인/νšŒμ›κ°€μž…μ„ 톡해 얻은 토큰값 (token <token>)

Response

Body

Name Data Type Number Description
nickname String 1 μ‚¬μš©μžμ˜ λ‹‰λ„€μž„
email String 1 μ‚¬μš©μžμ˜ 이메일 
{
    "nickname": "test",
    "email": "test@naver.com"
}

νšŒμ› 정보 μˆ˜μ •

name method url description
νšŒμ› 정보 μˆ˜μ • PATCH /auth/user/ νšŒμ›(μžμ‹ )의 정보 μˆ˜μ •

Request

Header

Header Name Required Default Value Description
Authorization true - 둜그인/νšŒμ›κ°€μž…μ„ 톡해 얻은 토큰값 (token <token>)

Body

Name Data Type Required Default Value Description
email String false - 이메일(username으둜 μ‚¬μš©)
password String false - λΉ„λ°€λ²ˆν˜Έ
nickname String false - λ‹‰λ„€μž„ 
{
    "nickname":"test_2"
}

Response

Body

Name Data Type Number Description
nickname String 1 μ‚¬μš©μžμ˜ λ‹‰λ„€μž„
email String 1 μ‚¬μš©μžμ˜ 이메일 
{
    "nickname": "test_2",
    "email": "test2@naver.com"
}

νšŒμ› νƒˆν‡΄

name method url description
νšŒμ› νƒˆν‡΄ DELETE /auth/user/ νšŒμ› νƒˆν‡΄(μ¦‰μ‹œ 반영)

Request

Header

Header Name Required Default Value Description
Authorization true - 둜그인/νšŒμ›κ°€μž…μ„ 톡해 얻은 토큰값 (token <token>)

Response

Body μ—†μŒ(μ„±κ³΅μ‹œ 204 No Content)

⚠️ **GitHub.com Fallback** ⚠️