Skip to content

admin api

Jump to bottom
echisan edited this page Jun 21, 2018 · 12 revisions

仪表盘

获取主要信息

GET /admin/mainInfo

返回结果

{
    "code": 0,
    "msg": "OK",
    "data": {
        "authOnline": 0,
        "totalVisitors": 1,
        "newUsers": 1,
        "totalUsers": 15,
        "anonOnline": 0,
        "newReplies": 0,
        "totalOnline": 0,
        "visit": 21
    }
}

用户管理

展示所有用户（根据create_time的倒叙进行排序）

GET /admin/users?pn={pn}&ps={ps}

参数 类型 说明
pn 页码 第几页（默认值为1）
ps 页大小 每一页获取多少数据（默认值为20）

请求示例/admin/users?pn=2&ps=10

返回结果

{
    "code": 0,
    "msg": "OK",
    "data": {
        "page": {
            "totalSize": 25,
            "pageSize": 10,
            "pageNumber": 2
        },
        "users": [
            {
                "userId": "4028ef8163cf0eb40163cf9e1c500017",
                "email": "awefaew@faewf.aef",
                "pwd": "$2a$10$FXdkh7DokBxXXZyy.OKsoeWyg3rLMpzBs5vVC346QmbTGm1G4O5LK",
                "phone": "",
                "nick": "fawef",
                "age": 0,
                "sex": "不明",
                "face": "",
                "role": "ROLE_USER",
                "emailVerified": 0,
                "phoneVerified": 0,
                "createTime": 1528196636000,
                "modifyTime": 1528196636000,
                "isLock": 0,
                "lockTime": 0
            },
        ]
    }
}

获取用户信息（单个）

GET /admin/users/{uid}

参数 类型 说明
uid String 用户id

返回结果

{
    "code": 0,
    "msg": "OK",
    "data": {
        "userId": "4028e381638d71d1016392b283ac0000",
        "email": "admin@admin.com",
        "pwd": "$2a$10$6R/pnzs3Ae6OHjTCgrTgTec0yTCvBOHkayGsJOHPr2bKU7aYoeK.u",
        "phone": "",
        "nick": "admin",
        "age": 0,
        "sex": "不明",
        "face": "/static/img/zm.jpg",
        "role": "ROLE_ADMIN",
        "emailVerified": 0,
        "phoneVerified": 0,
        "createTime": 1528640433000,
        "modifyTime": 1528640433000,
        "isLock": 1,
        "lockTime": 1000
    }
}

查询用户

GET /admin/users/nick?nick={nick}&pn={pn}&ps={ps}

一般只需要这样就ok了/admin/users/nick?nick?={nick}

请求示例 /admin/users/nick?nick=a&pn=1&ps=5

参数 类型 说明
nick 昵称 昵称
pn 页码 第几页（默认值为1）
ps 页大小 每一页获取多少数据（默认值为20）

返回结果

{
    "code": 0,
    "msg": "OK",
    "data": {
        "page": {
            "totalSize": 18,
            "pageSize": 5,
            "pageNumber": 1
        },
        "users": [
            {
                "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
            },
        ]
    }
}

删除指定id的用户

DELETE /admin/users/{uid}

请求示例

/admin/users/4028e3816386dd04016386dd3fe90000

返回结果

{
    "code": 0,
    "msg": "删除成功",
    "data": []
}

封禁/解封用户

PUT /admin/users/{uid}/lock/{action}/{time}

参数 类型 说明
uid String 用户id
action Integer 此参数总共有2个取值，分别为0,1，(0：解封用户，1：封禁用户)
time Integer 单位还没确定（秒？分钟？小时？） 如果action=0时不填，action=1时才需要填
参数 类型 说明
pwd string 密码

封禁请求示例

url: /admin/users/4028ef8163e8ce960163e8d2a9050000/lock/1/1

json:

{
    "pwd":"adminpwd"
}

返回结果

{
    "code": 0,
    "msg": "已封禁账号[test],锁定时长为[1]",
    "data": {
        "userId": "4028ef8163e8ce960163e8d2a9050000",
        "email": "t@t.t",
        "pwd": "$2a$10$Vo3a6pm9rU5X9rYepLl2cunsehuaLE7lO/quhXXRFqGFRJQVqJmiK",
        "phone": "",
        "nick": "test",
        "age": 0,
        "sex": "不明",
        "face": "",
        "role": "ROLE_USER",
        "emailVerified": 0,
        "phoneVerified": 0,
        "createTime": 1528636137000,
        "modifyTime": 1528636209882,
        "isLock": 1,
        "lockTime": 1
    }
}

解封请求示例 /admin/users/4028ef8163e8ce960163e8d2a9050000/lock/0

{
    "code": 0,
    "msg": "已解封账号[test]",
    "data": {
        "userId": "4028ef8163e8ce960163e8d2a9050000",
        "email": "t@t.t",
        "pwd": "$2a$10$Vo3a6pm9rU5X9rYepLl2cunsehuaLE7lO/quhXXRFqGFRJQVqJmiK",
        "phone": "",
        "nick": "test",
        "age": 0,
        "sex": "不明",
        "face": "",
        "role": "ROLE_USER",
        "emailVerified": 0,
        "phoneVerified": 0,
        "createTime": 1528636209000,
        "modifyTime": 1528637068589,
        "isLock": 0,
        "lockTime": 0
    }
}

提升（撤销）为管理员，系统管理员，普通用户

PUT /admin/users/{uid}/role/{action}

参数 类型 说明
uid String 用户id
action Integer 此参数总共有3个取值，分别为0,1,2。
action取值 行为
0 将该用户设置为普通用户(USER)
1 将该用户设置为管理员(MANAGER)
2 将该用户设置为系统管理员(ADMIN)
参数 类型 说明
pwd string 密码

请求示例

url部分 /admin/users/4028ef8163e8ce960163e8d2a9050000/role/0

json部分

{
    "pwd":"adminPwd"
}

返回结果

{
    "code": 0,
    "msg": "已将该用户[test]设置为[普通用户]",
    "data": {
        "userId": "4028ef8163e8ce960163e8d2a9050000",
        "email": "t@t.t",
        "pwd": "$2a$10$Vo3a6pm9rU5X9rYepLl2cunsehuaLE7lO/quhXXRFqGFRJQVqJmiK",
        "phone": "",
        "nick": "test",
        "age": 0,
        "sex": "不明",
        "face": "",
        "role": "ROLE_USER",
        "emailVerified": 0,
        "phoneVerified": 0,
        "createTime": 1528636093000,
        "modifyTime": 1528636137408,
        "isLock": 0,
        "lockTime": 0
    }
}

Token管理

获取以登录的用户列表

GET /admin/tokens?pn={pn}&ps={ps}

参数 类型 说明
pn 页码 第几页（默认值为1）
ps 页大小 每一页获取多少数据（默认值为20）

返回结果

{
    "code": 0,
    "msg": "OK",
    "data": {
        "page": {
            "totalSize": 17,
            "pageSize": 10,
            "pageNumber": 1
        },
        "tokensInfo": [
            {
                "uid": "4028e3816386ea9b016386f4f5d80002",
                "nick": "echisan",
                "issAt": 1528533795000, 签发时间戳
                "expAt": 1531125795000,  过期时间戳
                "token": "eyJ0eXAiOiJKV1QiLCJhbGc... ...rgLq73XRwKG-pnNC6QmEwI5dveoFqepCeAQn9w"
            },
        ]
    }
}

删除指定token

由于url有大小限制，token太长，只能以这样的方式进行删除了。

DELETE /admin/tokens

参数 类型 说明
token String 需要删除的token

请求示例

{
	"token":"eyJ0eXAiOiJKV1QiLCJhbGciOiJI......Z3ugGsGg"
}

返回结果

{
    "code": 0,
    "msg": "删除成功",
    "data": []
}
{
    "code": 5001,
    "msg": "该token不存在，无法删除",
    "data": []
}
Clone this wiki locally