API 명세서_User API

2021.01.14. nickname이 string이 아닌 integer type으로 적혀있던 오타 수정

User API

메소드	경로	설명	구현 여부
POST	~/users	유저 생성
PUT	~/users/:user-id	유저 정보 수정

Create User

• user 생성 api

메소드	경로	설명
POST	~/users	유저 생성

Header

Name	Type	Description	Mandatory
Content-Type	string	반환받을 타입	Y

Content-Type: application/json

Request Body

Name	Type	Description	Mandatory
uuid	string	기기 고유 식별자	Y
nickname	string	유저 닉네임	Y

성공 시 Response Body

{
    "user": {
        "id": 0,
        "nickname": "홍길동"
    },
    "token": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiIxMjM0NTY3ODkwIiwibmFtZSI6IkpvaG4gRG9lIiwiaWF0IjoxNTE2MjM5MDIyfQ.SflKxwRJSMeKKF2QT4fwpMeJf36POk6yJV_adQssw5c",
    "message": "유저 생성 성공"
}

Type	Name	Description
User	user	유저
- int	id	유저 id
- string	nickname	유저 닉네임
string	token	토큰
string	message	상태 메시지

Modify User

• user 수정 api

메소드	경로	설명
PUT	~/users/:user-id	유저 정보 수정

Header

Name	Type	Description	Mandatory
x-access-token	string	토큰	Y
Content-Type	string	반환받을 타입	Y

x-access-token: {"token"}
Content-Type: application/json

Path Parameter

Name	Type	Description	Mandatory
user-id	integer	수정할 유저 id	Y

Request Body

Name	Type	Description	Mandatory
nickname	string	유저 고유 식별자	Y

성공 시 Response Body

{
    "user": {
        "id": 0,
        "nickname": "홍길동"
    },
    "token": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiIxMjM0NTY3ODkwIiwibmFtZSI6IkpvaG4gRG9lIiwiaWF0IjoxNTE2MjM5MDIyfQ.SflKxwRJSMeKKF2QT4fwpMeJf36POk6yJV_adQssw5c",
    "message": "유저 닉네임 변경 성공"
}

Type	Name	Description
User	user	유저
- int	id	유저 id
- string	nickname	유저 닉네임
string	token	토큰
string	message	상태 메시지