管理员模块接口文档

一、管理员登录

1、基本信息：

请求路径：/administrator
请求方式：POST
接口描述：该接口用于管理员登录

2、请求参数：
请求参数格式：application/x-www-form-urlencoded

参数名称	说明	类型	是否必须	备注
name	管理员名称	String	是
password	密码	String	是

3、请求样例：

{
    "name":"MiniShopping.edg.gdut",
    "password":"MiniShopping.edg.gdut"
}

4、响应数据：
响应类型：applicaytion/json
响应参数说明：

参数名称	类型	是否必须	默认值	备注	其他信息
code	number	是		响应码，0-成功，1-失败
message	String	否		提示信息
data	String	否		返回的数据

响应数据样例：

{
    "code": 0,
    "massage": "操作成功",
    "data": "当前时间： 01:37:42.908597300 来自于 MiniShopping "
}

二、用户搜索

1、基本信息：

请求路径：/user/search
请求方式：GET
接口描述：该接口用于管理员在搜索条件下获取用户信息

2、请求参数：
请求参数格式：Params

参数名称	说明	类型	是否必须	备注
pageNum	页面最大数	number	是
pageSize	页面数	number	是
phone	用户手机号	String	否	可以不传也可以传空值，支持模糊搜索
nickname	用户昵称	String	否	可以不传也可以传空值，支持模糊搜索
gender	用户性别	String	否	可以不传也可以传空值，支持模糊搜索
email	用户邮件地址	String	否	可以不传也可以传空值，支持模糊搜索
address	用户地址	String	否	可以不传也可以传空值，支持模糊搜索
active_time	最近活跃时间	Date	否	可以不传也可以传空值，；；；；用户里最后一次登录时间没有超过该值的将被输出

备注：如果除了必要参数pageNum和pageSize，没有任何参数，将默认导出所有用户信息

3、请求样例：

~/user/search?pageNum=1&pageSize=1&phone=123456789&nickname&gender&email&address&active_time=2024-11-17T08:54:43

4、响应数据：
响应类型：applicaytion/json
响应参数说明：

参数名称	类型	是否必须	默认值	备注	其他信息
code	number	是		响应码，0-成功，1-失败
message	String	否		提示信息
data	String	否		返回的数据

响应数据样例：

{
    "code": 0,
    "massage": "操作成功",
    "data": {
        "total": 1,
        "list": [
            {
                "id": 1,
                "phone": "12345678901",
                "nickname": "",
                "gender": "",
                "user_pic": "https://img.ixintu.com/download/jpg/20200910/f9256155491e54bf5e99bf29eece0156_512_512.jpg!ys",
                "address": "",
                "email": "",
                "create_time": "2024-11-20 02:51:14",
                "update_time": "2024-11-20 02:51:14",
                "cart": "12,1,1,4,7,9",
                "active_time": "2024-11-20 02:51:22"
            }
        ]
    }
}

total为查询结果数量（数据库全部查询结果，没有分页情况下的数量），list为查询结果列表(根据页码pageNum和一个分页大小pageSize分配结果)

三、用户删除

1、基本信息：

请求路径：/user
请求方式：DELETE
接口描述：该接口用于管理员删除长时间不使用的用户账号

2、请求参数：
请求参数格式：x-www-form-urlencoded

参数名称	说明	类型	是否必须	备注
id	用户ID	number	是

3、请求样例：

{
    id=1
}

4、响应数据：
响应类型：applicaytion/json
响应参数说明：

参数名称	类型	是否必须	默认值	备注	其他信息
code	number	是		响应码，0-成功，1-失败
message	String	否		提示信息
data	String	否		返回的数据

响应数据样例：

{
    "code": 0,
    "massage": "操作成功",
    "data": "当前时间： 01:37:42.908597300 来自于 MiniShopping "
}

四、公告栏更新

1、基本信息：

请求路径：/administrator
请求方式：PUT
接口描述：该接口用于管理员更新公告栏

2、请求参数：
请求参数格式：applocation/json

参数名称	说明	类型	是否必须	备注
board	公告栏内容	String	是
3、请求样例：

{
    "board":"欢迎"
}

4、响应数据：
响应类型：applicaytion/json
响应参数说明：

参数名称	类型	是否必须	默认值	备注	其他信息
code	number	是		响应码，0-成功，1-失败
message	String	否		提示信息
data	String	否		返回的数据

响应数据样例：

{
    "code": 0,
    "massage": "操作成功",
    "data": "当前时间： 01:37:42.908597300 来自于 MiniShopping "
}

五、获取公告栏

1、基本信息：

请求路径：/administrator
请求方式：GET
接口描述：该接口用于获取公告栏内容

2、请求参数：无
3、请求样例：无
4、响应数据：
响应类型：applicaytion/json
响应参数说明：

参数名称	类型	是否必须	默认值	备注	其他信息
code	number	是		响应码，0-成功，1-失败
message	String	否		提示信息
data	String	否		返回的数据

响应数据样例：

{
    "code": 0,
    "massage": "操作成功",
    "data": "欢迎"
}