Skip to content

user

Jump to bottom
echisan edited this page Aug 17, 2018 · 3 revisions

user

  • 注册(新增用户)

参数

Name Type Description
nick String 用户昵称(帐号)可以等同于username
pwd String 密码
email String 邮箱地址

请求示例

POST /users

返回数据

{
    "code": 0,
    "msg": "注册成功",
    "data": {
        "userId": "4028e3816386ddd5016386de3b720000",
        "email": "example555@email.com",
        "pwd": "不让看",
        "phone": "",
        "nick": "echisan555",
        "age": 0,
        "sex": "不明",
        "face": "",
        "role": "ROLE_USER",
        "emailVerified": 0,
        "phoneVerified": 0,
        "createTime": 1526976101210,
        "modifyTime": 1526976101210,
        "isLock": 0,
        "lockTime": 0
    }
}

失败返回数据

{
    "code": 1001,
    "msg": "该邮箱地址已被使用",
    "data": []
}
{
    "code": 1001,
    "msg": "该用户已存在",
    "data": []
}
  • 获取users列表(仅允许管理员) GET /users GET /users?page=0&size=10 (推荐)

参数

Name Type Description
page Integer 需要请求的页码，从0开始
size Integer 每一页的大小

返回数据

{
    "code": 0,
    "msg": "OK",
    "data": {
        "content": [
            {
                "userId": "4028e3816386dd04016386dd3fe90000",
                "email": "example2333333rr3@email.com",
                "pwd": "$2a$10$0.qX3pHnJJpfUpx/cpRyMuzd8z1mKGogcMKtJyr.lAg0CAF/dL5YW",
                "phone": "",
                "nick": "echisanrrr2333222",
                "age": 0,
                "sex": "不明",
                "face": "",
                "role": "ROLE_USER",
                "emailVerified": 0,
                "phoneVerified": 0,
                "createTime": 1526976037000,
                "modifyTime": 1526976037000,
                "isLock": 0,
                "lockTime": 0
            },
            {
                "userId": "4028e3816386ddd5016386de3b720000",
                "email": "example555@email.com",
                "pwd": "$2a$10$AF3riQ2NubmlQ1D2lMRZa.L67yTitqZ6o1qCuiW2xpZ6p21MRi.xC",
                "phone": "",
                "nick": "echisan555",
                "age": 0,
                "sex": "不明",
                "face": "",
                "role": "ROLE_USER",
                "emailVerified": 0,
                "phoneVerified": 0,
                "createTime": 1526976101000,
                "modifyTime": 1526976101000,
                "isLock": 0,
                "lockTime": 0
            }
        ],
        "pageable": {
            "sort": {
                "sorted": true,
                "unsorted": false
            },
            "offset": 0,
            "pageSize": 2,
            "pageNumber": 0,
            "paged": true,
            "unpaged": false
        },
        "totalElements": 8,
        "totalPages": 4,
        "last": false,
        "number": 0,
        "size": 2,
        "sort": {
            "sorted": true,
            "unsorted": false
        },
        "numberOfElements": 2,
        "first": true
    }
}
  • 获取指定id的用户 GET /users/{userId} 
{
    "code": 0,
    "msg": "OK",
    "data": {
        "userId": "4028e3816386ea9b016386f5ab850005",
        "email": "dick1@qq.com",
        "pwd": "$2a$10$CCbjMmQVHLQaXvAn2URdj.LdbdigfrE2B9kfmjMeO51j.gKiKsf.m",
        "phone": "",
        "nick": "dick1",
        "age": 0,
        "sex": "不明",
        "face": "",
        "role": "ROLE_USER",
        "emailVerified": 0,
        "phoneVerified": 0,
        "createTime": 1526977637000,
        "modifyTime": 1526977637000,
        "isLock": 0,
        "lockTime": 0
    }
}

失败返回数据

{
    "code": 5001,
    "msg": "数据未找到",
    "data": []
}
  • 更新指定id用户 PUT /users/{userId}

成功返回数据

{
    "code": 0,
    "msg": "修改成功",
    "data": {
        "userId": "4028e3816386ea9b0163870c95460007",
        "email": "gaygui@gay.com",
        "pwd": "_(:3」∠)_",
        "phone": "1234567890",
        "nick": "gaygui2",
        "age": 0,
        "sex": "不明",
        "face": "",
        "role": "ROLE_USER",
        "emailVerified": 0,
        "phoneVerified": 0,
        "createTime": 1526980201000,
        "modifyTime": 1526982335337,
        "isLock": 0,
        "lockTime": 0
    }
}

失败返回数据

{
    "code": 6001,
    "msg": "无访问权限",
    "data": []
}
{
    "code": 1001,
    "msg": "该昵称已被使用",
    "data": []
}
  • 删除指定id登陆记录

DELETE /users/{userId}

参数

返回数据

{
    "code": 0,
    "msg": "OK",
    "data": []
}

失败返回数据

{
    "code": 6001,
    "msg": "无访问权限",
    "data": []
}

修改邮箱地址

/users/{uid}/email

参数

Name Type Description
uid Long user id
email String 新的邮箱地址
rcode String 验证码

请求实例 url: /user/1/email

body:

{
  "email":"a@q.c",
  "rcode":"111"
}

(1) 获取验证码

image

忘记密码

流程图 界面具体可以参考下B站找回密码

image

①确认账号

/pwd/forget/cemail

POST

参数

Name Type Description
email String 需要找回的账号的邮箱地址

请求实例

url: /pwd/forget/cemail

{
    "email":"ed@ed.ed"
}

响应结果

{
    "code": 0,
    "msg": "OK",
    "data": {
        "ticket": "265cd2a6b95e4cd697c49a0d46b1af10",
        "value": "1***@qq.com"
    }
}

②获取验证码

/pwd/forget/vcode

GET

参数

Name Type Description
ticket String 由第一步得到的ticket

请求实例 /users/pwd/forget/vcode?ticket=265cd2a6b95e4cd697c49a0d46b1af10

响应结果

{
    "code": 0,
    "msg": "验证码已发送，请前往目标邮箱查看。",
    "data": []
}

③修改密码

/users/pwd/forget/reset

PUT

参数

Name Type Description
ticket String 由第一步得到的ticket
pwd String 新密码
rcode String 验证码

请求实例

{
	"pwd":"echisan",
	"ticket":"265cd2a6b95e4cd697c49a0d46b1af10",
	"rcode":"981334"
}

返回结果 !!!!注意!!!当响应的code=3002时，需要重新跳回第一步重新进行操作， code==3002,意思是凭证过期，即是ticket(有效期2个小时)过期了，需要在第一步重新申请

{
    "code": 5005,
    "msg": "该验证码已过期，请重新获取",
    "data": []
}
{
    "code": 0,
    "msg": "密码修改成功",
    "data": []
}

Clone this wiki locally